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

documentation/python: make links to literal ellipses as well #214

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

mosra
Copy link
Owner

@mosra mosra commented Jan 10, 2022

If a literal ... is in a type annotation, it should link to Python documentation like any other builtin type. TODOs:

  • right now it's changed to a link that says Ellipsis instead of ..., which isn't desired
    • there has to be either some special-casing inside m.sphinx inventory parsing (but that'd have to narrow this patching down to just Python's own inventory, which is rather impossible to detect)
    • or there has to be e.g. an optional argument to make_name_link() that overrides the link title.
  • the commit message has a silly typo

If a literal `...` is in a type annotation, it should link to Python
documentation like any other builtin type.

TODO: right now it's changed to a link that says Ellipsis instead of
  ..., which isn't desired -- there has to be either some special-casing
  inside m.sphinx inventory parsing (but that'd have to narrow this
  patching down to just Python's own inventory, which is rather
  impossible to detect), or there has to be e.g. an optional argument to
  make_name_link() that overrides the link title.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

1 participant