See Also syntax

16 views
Skip to first unread message

Chris Smith

unread,
Mar 23, 2020, 6:08:55 PM3/23/20
to sympy
The documentation says the following about "See Also" sections:

The See Also section should only be used to reference other SymPy objects. Anything that is a link should be embedded as a hyperlink in the text of the docstring instead; see the References section for details.
Do not reference classes with class:Classnameclass:`Classname`, or :class:`Classname`, but rather only by their class name.

I can't tell from this what they are actually advocating or discouraging. I see that sometimes we have relative references like 

- `.file.func` to refer to `func` in the file `file` of the current folder
- `func` in the same file as the one in which the See Also is appearing
- `sympy.module.file.func` to give the full path

I am getting an error in https://github.com/sympy/sympy/pull/18940 when trying to use relative referencing. Any help would be appreciated.

/c

Aaron Meurer

unread,
Mar 24, 2020, 12:52:46 AM3/24/20
to sympy
The docs are only saying that you don't need the extra rst syntax with
:class: or backticks in the See Also section, like you would
elsewhere.

I suspect the issue in your PR is that the thing you are trying to
reference isn't included in Sphinx, so it can't link to anywhere.

Aaron Meurer
> --
> You received this message because you are subscribed to the Google Groups "sympy" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to sympy+un...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/sympy/69fbd532-7671-4b78-b0b8-40a1b1a63a6c%40googlegroups.com.
Reply all
Reply to author
Forward
0 new messages