numpy / numpydoc

Numpy's Sphinx extensions
https://numpydoc.readthedocs.io/
Other
302 stars 161 forks source link

Should "See also" be symetric? #173

Open fmaussion opened 6 years ago

fmaussion commented 6 years ago

I learned about the existence of argwhere only recently, although I'm using where very often.

One possible reason for this is that "See also" in the where documentation doesn't link to argwhere, while the latter does link to where.

I guess there must be a programmatic way to make these cross-references symmetric by default, and I wonder if that could be a useful feature for numpydoc...

jnothman commented 6 years ago

I don't think making links symmetric by default is necessarily what you want, especially as we want equivalence between a processed (i.e. sphinx) and raw (i.e. pydoc) docstring. I do think this would be an interesting feature among numerous potential integrity checking tools...