Ticket #5531 (closed defect: fixed)

Opened 4 years ago

Last modified 4 years ago

[with patch, positive review] Quaternion algebra docstring formatting needs small fixes

Reported by: davidloeffler Owned by: davidloeffler
Priority: major Milestone: sage-3.4.1
Component: documentation Keywords:
Cc: Work issues:
Report Upstream: Reviewers: Minh Van Nguyen
Authors: David Loeffler Merged in: 3.4.1.alpha0
Dependencies: Stopgaps:

Description

In a vanilla copy of 3.4, I get complaints from sage -docbuild because some of the docstrings in sage/algebras/quaternion_algebra.py are wrongly formatted. 

WARNING: /home/david/sage-current/local/lib/python2.5/site-packages/sage/algebras/quaternion_algebra.py:docstring of sage.algebras.quaternion_algebra.unpickle_QuaternionAlgebra_v0:4: (WARNING/2) Inline emphasis start-string without end-string.
WARNING: /home/david/sage-current/local/lib/python2.5/site-packages/sage/algebras/quaternion_algebra_element.so:docstring of sage.algebras.quaternion_algebra_element.QuaternionAlgebraElement_abstract.conjugate:13: (WARNING/2) Inline literal start-string without end-string.
WARNING: /home/david/sage-current/local/lib/python2.5/site-packages/sage/algebras/quaternion_algebra_element.so:docstring of sage.algebras.quaternion_algebra_element.QuaternionAlgebraElement_generic:3: (WARNING/2) Literal block expected; none found.
WARNING: /home/david/sage-current/local/lib/python2.5/site-packages/sage/algebras/quaternion_algebra_element.so:docstring of sage.algebras.quaternion_algebra_element.QuaternionAlgebraElement_rational_field:4: (WARNING/2) Literal block expected; none found.
WARNING: /home/david/sage-current/local/lib/python2.5/site-packages/sage/algebras/quaternion_algebra_element.so:docstring of sage.algebras.quaternion_algebra_element.unpickle_QuaternionAlgebraElement_generic_v0:2: (WARNING/2) Inline emphasis start-string without end-string.
WARNING: /home/david/sage-current/local/lib/python2.5/site-packages/sage/algebras/quaternion_algebra_element.so:docstring of sage.algebras.quaternion_algebra_element.unpickle_QuaternionAlgebraElement_generic_v0:2: (WARNING/2) Inline emphasis start-string without end-string.

This patch fixes that.

Attachments

quaternion_docstring_fix.patch Download (1.2 KB) - added by davidloeffler 4 years ago.

Change History

Changed 4 years ago by davidloeffler

comment:1 Changed 4 years ago by davidloeffler

  • Status changed from new to assigned

comment:2 Changed 4 years ago by mvngu

  • Summary changed from [with patch, needs review] Quaternion algebra docstring formatting needs small fixes to [with patch, positive review] Quaternion algebra docstring formatting needs small fixes

REFEREE REPORT

The patch quaternion_docstring_fix.patch applied OK against Sage 3.4, doctests passed even with the -long option, and the reference manual builds fine. Positive review for the Sphinx formatting issues that the patch fixes.

However, while reviewing the patch I noticed some other formatting issues. But these are addressed in ticket #5541.

comment:3 Changed 4 years ago by mabshoff

  • Status changed from assigned to closed
  • Resolution set to fixed

Merged in Sage 3.4.1.alpha0.

Cheers,

Michael

comment:4 Changed 4 years ago by davidloeffler

  • Reviewers set to Minh Van Nguyen
  • Merged in set to 3.4.1.alpha0
  • Authors set to David Loeffler
Note: See TracTickets for help on using tickets.