You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
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
That does seem like a minor regression, but I'm hesitant to ask
contributors to understand a complicated rule like that. It doesn't seem
like the kind of thing you can apply consistently without wasting a lot of
energy on it. It would be better to see if we can fix Sphinx somehow...
On Tue, Jul 2, 2019, 06:16 Joshua Oreman ***@***.***> wrote:
This was mostly resolved by #1091
<#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:?
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#78?email_source=notifications&email_token=AAEU42DNXZH3FJF44DW6TVDP5NIJHA5CNFSM4DDHISDKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODZBHLGI#issuecomment-507671961>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAEU42DGPYZ2NY5XQS7HIVLP5NIJHANCNFSM4DDHISDA>
.
See: http://www.sphinx-doc.org/en/stable/config.html#confval-default_role
The text was updated successfully, but these errors were encountered: