#9976: Decorated functions/methods have generic signature in documentation
--------------------------------+-------------------------------------------
Reporter: jsrn | Owner: mvngu
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-4.7
Component: documentation | Keywords: sphinx, documentation, cython
inspection
Author: jsrn, Simon King | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
--------------------------------+-------------------------------------------
Comment(by SimonKing):
After emptying my patch queue, applying our three patches, removing any
reference to `cachefunc` in the `build` directories, touching
`sage/rings/polynomial/multi_polynomial_ideal.py`,
`sage/rings/polynomial/multi_polynomial_ideal_libsingular.pyx`,
`sage/plot/contour_plot.py` and `sage/misc/cachefunc.py`, I did `sage -b`
and then `sage -docbuild html`.
So, I can be sufficiently sure that there is no leftover from previous
work, and that I am really only testing the effects of this ticket.
I obtain:
{{{
sphinx-build -b html -d
/mnt/local/king/SAGE/broken/devel/sage/doc/output/doctrees/en/reference
/mnt/local/king/SAGE/broken/devel/sage/doc/en/reference
/mnt/local/king/SAGE/broken/devel/sage/doc/output/html/en/reference
Running Sphinx v1.0.4
loading pickled environment... done
building [html]: targets for 98 source files that are out of date
updating environment: 0 added, 98 changed, 0 removed
reading sources... [ 72%]
sage/rings/polynomial/multi_polynomial_ideal_libsingulreading sources...
[100%] sage/symbolic/ring
<autodoc>:0: (ERROR/3) Unexpected indentation.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 78%]
sage/rings/polynomial/multi_polynomial_ideal_libsingulawriting output...
[100%] structure
writing additional files... genindex py-modindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 1 warning.
Build finished. The built documents can be found in
/mnt/local/king/SAGE/broken/devel/sage/doc/output/html/en/reference
}}}
I don't understand the warning about `autodoc`: It doesn't say which sage
file it is from.
The arguments in the documentation of groebner_basis are given by:
{{{
groebner_basis(algorithm, deg_bound, mult_bound='', prot=None, *args=None,
**kwds=False)
}}}
and of sage.plot.contour_plot.contour_plot:
{{{
sage.plot.contour_plot.contour_plot(f, xrange, yrange, axes=False,
linestyles=None, frame=True, labels=False, plot_points=100,
linewidths=None, colorbar=False, contours=None, legend_label=None,
fill=True, label_inline=None, label_fmt='%1.2f', label_fontsize=9,
label_colors='blue', label_inline_spacing=3, colorbar_spacing=None,
colorbar_orientation='vertical', colorbar_format=None, **options)
}}}
From my perspective, the problem is solved. I have already done the long
tests yesterday, and to be on the safe side, I repeat them now.
If we are allowed to do cross reviewing, I would give your patch a
positive review. Let's see what the fellow developers on sage-devel will
tell us...
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9976#comment:70>
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.
