Ticket #6585 (closed defect: fixed)

Opened 4 years ago

Last modified 4 years ago

[with patch, positive review] trivial change to a few docstrings in partition.py

Reported by: jhpalmieri Owned by: jhpalmieri
Priority: minor Milestone: sage-4.1.1
Component: documentation Keywords:
Cc: sage-combinat Work issues:
Report Upstream: Reviewers: Minh Van Nguyen
Authors: John Palmieri Merged in: Sage 4.1.1.alpha1
Dependencies: Stopgaps:

Description

This patch changes a few docstrings in partition.py which contain backslashes from 

"""
blah
"""

to 

r"""
blah
"""

(I've been playing with version 0.6.2 of Sphinx, and it barfs without making this change.)

Attachments

trac_6585-backslash.patch Download (3.2 KB) - added by jhpalmieri 4 years ago.
trac_6585-fix-warnings.patch Download (701 bytes) - added by mvngu 4 years ago.
fix warning when building HTML version of sage/combinat/partition.py

Change History

Changed 4 years ago by jhpalmieri

Changed 4 years ago by mvngu

fix warning when building HTML version of sage/combinat/partition.py

comment:1 Changed 4 years ago by mvngu

  • Status changed from new to closed
  • Reviewers set to Minh Van Nguyen
  • Resolution set to fixed
  • Merged in set to Sage 4.1.1.alpha1
  • Summary changed from [with patch, needs review] trivial change to a few docstrings in partition.py to [with patch, positive review] trivial change to a few docstrings in partition.py

Positive review for the patch trac_6585-backslash.patch. After importing the changes in that patch and rebuilding the HTML version of the reference manual, I got the following warning: 

WARNING: /scratch/mvngu/release/sage-4.1.1.alpha0/local/lib/python2.6/site-packages/sage/combinat/partition.py:docstring of sage.combinat.partition.Partition_class.conjugate:1: (WARNING/2) Inline literal start-string without end-string.

This is fixed by trac_6585-fix-warnings.patch. Merged both patches.

Note: See TracTickets for help on using tickets.