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

docs: default_role = "obj" leaves function references without their parens #78

Open
njsmith opened this issue Mar 10, 2017 · 2 comments

Comments

@njsmith
Copy link
Member

njsmith commented Mar 10, 2017

See: http://www.sphinx-doc.org/en/stable/config.html#confval-default_role

@oremanj
Copy link
Member

oremanj commented Jul 2, 2019

The original issue here (enabling default_role = "obj") was resolved by #1091, but I just noticed that referring to a function with bare backticks drops the trailing () that you get with :func: or :meth:. This seems like a regression to me... if it's not possible to get the () back, then maybe we want to stick with :func: and :meth: for referring to functions, and only use bare backticks where we would use :attr:, :class:, or :data:?

@oremanj oremanj changed the title docs: set default_role = "obj" and refactor the docs to take advantage of it docs: default_role = "obj" leaves function references without their parens Jul 2, 2019
@njsmith
Copy link
Member Author

njsmith commented Jul 2, 2019 via email

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

No branches or pull requests

2 participants