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

Inconsistent intersphinx link generation in docstrings #282

Closed
tsbinns opened this issue Jan 28, 2025 · 3 comments
Closed

Inconsistent intersphinx link generation in docstrings #282

tsbinns opened this issue Jan 28, 2025 · 3 comments

Comments

@tsbinns
Copy link
Collaborator

tsbinns commented Jan 28, 2025

In #280 I noticed instances where ticks around class names where simply italicising words rather than rendering it as code and generating intersphinx links, especially for standard Python things like None, str, tuple, True, etc..., e.g.:

Image

Should explicit intersphinx roles be provided to fix this, or should double ticks simply be used to render the text as code (but with no link, i.e., None)?

@drammock
Copy link
Member

xref to my answer elsewhere: #280 (comment)

@tsbinns
Copy link
Collaborator Author

tsbinns commented Jan 28, 2025

Okay, I'll go through later and fix the inconsistencies.

@tsbinns
Copy link
Collaborator Author

tsbinns commented Feb 5, 2025

Sorted in #283

@tsbinns tsbinns closed this as completed Feb 5, 2025
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

No branches or pull requests

2 participants