Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix hash capitalization in API links #2204

Merged
merged 1 commit into from
Oct 30, 2024
Merged

Fix hash capitalization in API links #2204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions scripts/js/lib/api/updateLinks.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,11 @@ test.describe("updateLinks", () => {
[link3](qiskit_ibm_runtime.RuntimeJob.job#wut)
[link4](../stubs/qiskit_ibm_runtime.RuntimeJob)
[link5](../apidocs/qiskit_ibm_runtime.RuntimeJob#qiskit_ibm_runtime.RuntimeJob)
[link6](qiskit_ibm_runtime.RuntimeJob)
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a new link 6, so updated the link numbers for all these

[link7](#qiskit_ibm_runtime.RuntimeJob.job)
[link8](https://qiskit.org/documentation/apidoc/algorithms.html)
[link9](https://qiskit.org/documentation/stubs/qiskit.circuit.BreakLoopOp.html#assemble)
[link6](../apidocs/qiskit_ibm_runtime.RuntimeJob#SOME_VAR)
[link7](qiskit_ibm_runtime.RuntimeJob)
[link8](#qiskit_ibm_runtime.RuntimeJob.job)
[link9](https://qiskit.org/documentation/apidoc/algorithms.html)
[link10](https://qiskit.org/documentation/stubs/qiskit.circuit.BreakLoopOp.html#assemble)
`,
meta: {
apiType: "class",
Expand Down Expand Up @@ -92,10 +93,11 @@ test.describe("updateLinks", () => {
[link3](qiskit_ibm_runtime.RuntimeJob#job)
[link4](qiskit_ibm_runtime.RuntimeJob)
[link5](qiskit_ibm_runtime.RuntimeJob)
[link6](qiskit_ibm_runtime.RuntimeJob)
[link7](#qiskit_ibm_runtime.RuntimeJob.job)
[link8](/api/qiskit/algorithms)
[link9](/api/qiskit/qiskit.circuit.BreakLoopOp#assemble)\n`,
[link6](qiskit_ibm_runtime.RuntimeJob#some_var)
[link7](qiskit_ibm_runtime.RuntimeJob)
[link8](#qiskit_ibm_runtime.RuntimeJob.job)
[link9](/api/qiskit/algorithms)
[link10](/api/qiskit/qiskit.circuit.BreakLoopOp#assemble)\n`,
meta: {
apiName: "qiskit_ibm_runtime.RuntimeJob",
apiType: "class",
Expand Down Expand Up @@ -143,10 +145,11 @@ test.describe("updateLinks", () => {
[link3](runtime-job#job)
[link4](runtime-job)
[link5](runtime-job)
[link6](runtime-job)
[link7](#qiskit_ibm_runtime.RuntimeJob.job)
[link8](/api/qiskit/algorithms)
[link9](/api/qiskit/qiskit.circuit.BreakLoopOp#assemble)\n`,
[link6](runtime-job#some_var)
[link7](runtime-job)
[link8](#qiskit_ibm_runtime.RuntimeJob.job)
[link9](/api/qiskit/algorithms)
[link10](/api/qiskit/qiskit.circuit.BreakLoopOp#assemble)\n`,
meta: {
apiName: "qiskit_ibm_runtime.RuntimeJob",
apiType: "class",
Expand Down
22 changes: 8 additions & 14 deletions scripts/js/lib/api/updateLinks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,17 +81,21 @@ export function normalizeUrl(
"/",
);

// Default case. We'll then check if the hash should be transformed
// for a few edge cases.
url = hash ? `${normalizedUrlWithoutHash}#${hash}` : normalizedUrlWithoutHash;

// qiskit_ibm_runtime.RuntimeJob
// qiskit_ibm_runtime.RuntimeJob#qiskit_ibm_runtime.RuntimeJob
if (itemNames.has(page)) {
if (hash === page) {
return normalizedUrlWithoutHash;
url = normalizedUrlWithoutHash;
}

// qiskit_ibm_runtime.RuntimeJob#qiskit_ibm_runtime.RuntimeJob.job -> qiskit_ibm_runtime.RuntimeJob#job
if (hash?.startsWith(`${page}.`)) {
const member = removePrefix(hash, `${page}.`);
return `${normalizedUrlWithoutHash}#${member}`;
url = `${normalizedUrlWithoutHash}#${member}`;
}
}

Expand All @@ -104,20 +108,10 @@ export function normalizeUrl(
const normalizedParentName = kwargs.kebabCaseAndShorten
? kebabCaseAndShortenPage(parentName, kwargs.pkgName)
: parentName;
return [...initialUrlParts, normalizedParentName].join("/") + "#" + member;
url = [...initialUrlParts, normalizedParentName].join("/") + "#" + member;
}

if (!hash) return normalizedUrlWithoutHash;

// Anchors generated from markdown headings are always lower case but, if these
// headings are API references, Sphinx sometimes expects them to include
// uppercase characters.
Comment on lines -112 to -114
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This came from the helper function lowerCaseIfMarkdownAnchor. I accidentally didn't delete it last PR. Its implementation was more robust so I use that rather than inlining

//
// As a heuristic, we assume URLs containing periods are anchors to HTML id
// tags (which preserve Sphinx's original casing), and anchors with no periods
// are from markdown headings (which must be lower-cased). This seems to work ok.
const normalizedHash = hash.includes(".") ? hash : hash.toLowerCase();
return `${normalizedUrlWithoutHash}#${normalizedHash}`;
return lowerCaseIfMarkdownAnchor(url);
}

export function relativizeLink(link: Link): Link | undefined {
Expand Down