numpydoc icon indicating copy to clipboard operation
numpydoc copied to clipboard

Should "See also" be symetric?

Open fmaussion opened this issue 7 years ago • 1 comments

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...

fmaussion avatar Apr 24 '18 19:04 fmaussion

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...

jnothman avatar Apr 25 '18 12:04 jnothman