Skip to content

[MRG] DOC Link items explictly #14817

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

Merged
merged 4 commits into from
Sep 5, 2019

Conversation

thomasjpfan
Copy link
Member

Fixes #14665

This PR:

  1. Updates every link and explicitly links to the glossary, function, method, etc.
  2. Changes the default role to literal.

@thomasjpfan
Copy link
Member Author

CC @NicolasHug

The time has come to just treat single backticks as double backticks.

Copy link
Member

@jnothman jnothman left a comment

Choose a reason for hiding this comment

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

I've not checked every line, but I'm happy with this.

@adrinjalali
Copy link
Member

Not doing the X and y?

@thomasjpfan
Copy link
Member Author

Adding term to X and y seems a little less readable.

@adrinjalali
Copy link
Member

hmm, ok, I don't mind it much either way. LGTM once the conflict is resolved.

Copy link
Member

@NicolasHug NicolasHug left a comment

Choose a reason for hiding this comment

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

Haven't checked everything either, but LGTM

Thanks a lot for taking care of this @thomasjpfan

(not merging right away just in case someone else wants a look)

Copy link
Member

@adrinjalali adrinjalali left a comment

Choose a reason for hiding this comment

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

@amueller is probably not gonna be happy about this :P

@amueller
Copy link
Member

amueller commented Sep 4, 2019

I'm fine with it.

@lucyleeow
Copy link
Member

lucyleeow commented Sep 6, 2022

From: #24104 (comment), @thomasjpfan do you think it would be useful to add a bit in our documentation about single back ticks rendering as code blocks? (Edit: though not sure if there is consensus on what we want people to use...)
Also, I saw #14665 and although it has been a while, would it be useful to document that there was a change from the custom_references_resolver to explicit links (though maybe it is so old there is no point in telling people that it changed?)

@thomasjpfan
Copy link
Member Author

thomasjpfan commented Sep 6, 2022

do you think it would be useful to add a bit in our documentation about single back ticks rendering as code blocks?

I think most new docstring are single backticks these days. I think it's worth documenting because it is something specific to our sphinx configuration.

As for custom_references_resolver, I do not think we need to document it because we have not been using any as the default_role for a few years now. Also, I do not think custom_references_resolver.py is being used at all and can be removed.

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 this pull request may close these issues.

Document when to use single backticks
6 participants