#9976: Decorated functions/methods have generic signature in documentation
-----------------------------+----------------------------------------------
Reporter: jsrn | Owner: mvngu
Type: enhancement | Status: needs_work
Priority: major | Milestone: sage-4.7
Component: documentation | Keywords: sphinx, documentation
Author: jsrn | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
-----------------------------+----------------------------------------------
Comment(by SimonKing):
Replying to [comment:17 jsrn]:
> Replying to [comment:15 SimonKing]:
> > How is the documentation of a class, method etc. actually obtained?
There is a method `get_doc` in sage_autodoc.py, but it was not called
when I expected it.
>
> That is indeed surprising; I would have thought that was constructing
the documentation. You are aware that there are two get_doc functions: one
in the Documenter class (which is the father of all documenters), and the
overwritten in the ClassLevelDocumenter subclass?
I inserted commands into both `get_doc` methods that I found in
`sage_autodoc.py that should write some status reports into a file called
"simon_logfile" somewhere in my home directory. After deleting one file in
doc/output/html/en/reference and doing `sage -docbuild reference html`, no
file called "simon_logfile" can be found anywhere on the disk (even
outside my home directory).
Then, I bumped it up, and inserted a `raise RuntimeError` into the first
line of both methods. Nevertheless, the documentation builds as it did
before.
So, I must conclude that neither version of `get_doc` is used to get
documentation.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9976#comment:18>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
