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.

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

Fix potentially broken references in the documentation #1980

Closed
moe-ad opened this issue Jan 2, 2025 · 2 comments · Fixed by #2006
Closed

Fix potentially broken references in the documentation #1980

moe-ad opened this issue Jan 2, 2025 · 2 comments · Fixed by #2006
Assignees

Comments

@moe-ad
Copy link
Contributor

moe-ad commented Jan 2, 2025

As part of recently completed tasks in #296, it was decided to remove reference labels found in module docstrings (#1975). These labels became broken because section titles had been removed from the module docstrings as a fix to ensure icons properly render in the api documentation (#1971).

This purpose of this issue is to address the removed reference labels.

@PProfizi
Copy link
Contributor

PProfizi commented Jan 3, 2025

Hi @moe-ad,

are current references in the doc to these modules still going to work?

@moe-ad
Copy link
Contributor Author

moe-ad commented Jan 10, 2025

@PProfizi, sorry I didn't catch this earlier. The stable version of the doc is not impacted.
And now a PR(#2006) has been created to fix this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants