FIX handling of parameter names ending '_' #144
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This issue results from numpy#107: the explicit bold styling was removed because Sphinx definition lists bolded the term by default. However, without ** surrounding param name, a name like word_ was being treated as a link. I also attempted to replace the _ with \_ but found that the backslashes showed in the HTML. Thus I have reverted to wrapping param names in **.
|
I'd like to merge this to fix scikit-learn dev doc builds where attributes are currently hyperlinked to nothing... e.g. http://scikit-learn.org/dev/modules/generated/sklearn.ensemble.BaggingClassifier.html |
|
but I'd also like to know if there's a better solution |
|
I think we might need to merge this to make attributes ending _ not render as links. The correct solution is to escape with backslash, but docutils has only recently patched an issue with escaping underscores in definition lists. The current release of numpydoc includes this ** |
|
Tests are passing locally but not on Travis. Needs investigating |
This was referenced Mar 30, 2018
Closed
|
In it goes, thanks @jnothman |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This issue results from #107: the explicit bold styling was removed because Sphinx definition lists bolded the term by default. However, without
**surrounding param name, a name likeword_was being treated as a link. I also attempted to replace the_with\_but found that the backslashes showed in the HTML. Thus I have reverted to wrapping param names in**.