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

bold attributes so we don't have to deal with trailing underscores #63

Merged
merged 2 commits into from
Sep 12, 2016

Conversation

amueller
Copy link
Contributor

@amueller amueller commented Sep 7, 2016

Also looks better.

Fixes #62.

If the bold formatting is not for you, we can do backticks instead. I feel that attributes should be literals, not interpreted by sphinx.

amueller added a commit to amueller/scikit-learn that referenced this pull request Sep 7, 2016
@rgommers
Copy link
Member

rgommers commented Sep 8, 2016

That code is called from for param_list in ('Attributes', 'Methods'): so your change applies to method as well as attribute tables. And methods get turned into links, so I think this will break that (didn't try).

@rgommers
Copy link
Member

rgommers commented Sep 8, 2016

Bold formatting for attributes sounds fine to me, should look OK visually.

@amueller
Copy link
Contributor Author

amueller commented Sep 8, 2016

I'm not sure what you mean by "methods get turned into links". I guess that depends on the template?
Here there are separate pages for methods:
http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html

Scikit-learn doesn't do that:
http://scikit-learn.org/stable/modules/generated/sklearn.cluster.AffinityPropagation.html#sklearn.cluster.AffinityPropagation

Do you have a minimal example with methods that are links so I can test? I imagine that if a method contains a trailing underscore, that's also a problem.

@pv
Copy link
Member

pv commented Sep 8, 2016 via email

@rgommers
Copy link
Member

No I meant actual Methods sections in the docstring, like here:
https://github.com/scipy/scipy/blob/master/scipy/stats/kde.py#L80
http://scipy.github.io/devdocs/generated/scipy.stats.gaussian_kde.html#scipy.stats.gaussian_kde

Just tested this PR, looks like things still work so no issue.

@rgommers rgommers merged commit 8dd78ec into numpy:master Sep 12, 2016
@rgommers
Copy link
Member

OK, in it goes. Thanks @amueller

@rgommers rgommers added this to the v0.7.0 milestone Sep 12, 2016
@amueller
Copy link
Contributor Author

thanks. Sorry for being unresponsive.

@rgommers
Copy link
Member

thanks. Sorry for being unresponsive.

Eh? A couple of days doesn't count as unresponsive in my book. Or otherwise I should go make many handfuls of apologies right now:)

amueller added a commit to amueller/scikit-learn that referenced this pull request Oct 27, 2016
update numpydoc to upstream, include fix for line numbers

try to exclude numpydoc from unit test (why would we test those?!)

don't run flake8 on the sphinxext folder.

make attributes bold (and literal) so we don't have to worry about trailing underscores. numpy/numpydoc#63

actually exclude numpydoc from tests
mpharrigan pushed a commit to mpharrigan/numpydoc that referenced this pull request Nov 30, 2016
amueller added a commit to amueller/scikit-learn that referenced this pull request May 18, 2017
update numpydoc to upstream, include fix for line numbers

try to exclude numpydoc from unit test (why would we test those?!)

don't run flake8 on the sphinxext folder.

make attributes bold (and literal) so we don't have to worry about trailing underscores. numpy/numpydoc#63

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

Successfully merging this pull request may close these issues.

3 participants