Ticket #6435 (closed defect: fixed)

Opened 14 months ago

Last modified 14 months ago

[with patch, positive review] misformatted docstrings in sage.misc.abstract_method (easy fix)

Reported by: davidloeffler Owned by: tba
Priority: major Milestone: sage-4.1
Component: documentation Keywords: ReST docstring formatting
Cc: nthiery Author(s): John Palmieri
Report Upstream: Reviewer(s): Nicolas Thiéry
Merged in: sage-4.1.rc0 Work issues:

Description

Building the documentation for 4.1.alpha2, there is a warning: 

WARNING: /home/david/sage-4.1.alpha2/local/lib/python2.6/site-packages/sage/misc/abstract_method.py:docstring of sage.misc.abstract_method.abstract_method:19: (WARNING/2) Literal block expected; none found.

This is due to a rogue "::" in a docstring introduced by #6097.

Attachments

trac_6435.patch Download (0.8 KB) - added by jhpalmieri 14 months ago.

Change History

Changed 14 months ago by jhpalmieri

Changed 14 months ago by jhpalmieri

  • summary changed from misformatted docstrings in sage.misc.abstract_method (easy fix) to [with patch, needs review] misformatted docstrings in sage.misc.abstract_method (easy fix)
  • author set to John Palmieri

Here's a patch.

Changed 14 months ago by nthiery

  • summary changed from [with patch, needs review] misformatted docstrings in sage.misc.abstract_method (easy fix) to [with patch, positive review] misformatted docstrings in sage.misc.abstract_method (easy fix)

Oops, sorry for introducing this, and thanks for fixing it! Positive review.

Changed 14 months ago by mvngu

  • reviewer set to Nicolas Thiéry

Changed 14 months ago by rlm

  • status changed from new to closed
  • resolution set to fixed
  • merged set to sage-4.1.rc0
Note: See TracTickets for help on using tickets.