-
-
Notifications
You must be signed in to change notification settings - Fork 10.9k
WIP, DOC: Remove references for parameters in docstrings #17714
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
WIP, DOC: Remove references for parameters in docstrings #17714
Conversation
I think I agree with this change, but it goes directly against the directions for |
In fact, only a few of these backticks raises warnings. So this may be a bug of numpydoc. I'll try to fix numpydoc. |
The problem here is that |
Now I'm trying to solve by fixing numpydoc: numpy/numpydoc#303 |
I would not make a change here. That would lead to a lot of churn for little benefit. The trigger for this PR seems specific to |
@takanori-pskq do you have plans to update this PR? |
FWIW I think this is something that needs to be fixed in numpydoc - numpy is not the only project that has this problem with the default role: +1 for closing |
It looks like this is not the direction we want to go in, so I'll close. Feel free to create a new PR if you have other ideas, @takanori-pskq |
Related to #13114. Parameter names are not references, and marked up using
*
in other documents.