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

Use full anchor links for API docs once headings are moved inside components #2217

Open
Eric-Arellano opened this issue Oct 31, 2024 · 0 comments
Open

Use full anchor links for API docs once headings are moved inside components #2217

Eric-Arellano opened this issue Oct 31, 2024 · 0 comments
Labels
infra 🏗️ on hold ⏸️

Comments

@Eric-Arellano
Copy link
Collaborator

Implement #2215. Blocked by #1395.
@Eric-Arellano Eric-Arellano moved this to Blocked in Docs Planning Oct 31, 2024
@Eric-Arellano Eric-Arellano mentioned this issue Oct 31, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue Nov 1, 2024
@Eric-Arellano
Fix anchor links in API docs to inline class methods (#2218)
283ca70 
Closes #2210. Before,
cross references to inlined class methods would try using the link
`InlineClass.some_method`, but the link should really be `some_method`
without `InlineClass`.

The better fix is #2215
because it avoids the risk of ambiguous anchors. However, it would be a
UX regression to land that until
#1395 is done. Fixing this
is tracked by #2217.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
infra 🏗️ on hold ⏸️
Projects
Docs Planning
Status: Blocked
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Eric-Arellano