search

sagemath / sage

Main repository of SageMath
https://www.sagemath.org
Other
1.31k stars 449 forks source link

Quaternion algebra docstring formatting needs small fixes #5531

Closed 11d1fc49-71a1-44e1-869f-76be013245a0 closed 15 years ago

11d1fc49-71a1-44e1-869f-76be013245a0 commented 15 years ago

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.

Component: documentation

Author: David Loeffler

Reviewer: Minh Van Nguyen

Merged: 3.4.1.alpha0

Issue created by migration from https://trac.sagemath.org/ticket/5531

11d1fc49-71a1-44e1-869f-76be013245a0 commented 15 years ago
comment:1

Attachment: quaternion_docstring_fix.patch.gz

7c09a680-e216-4024-bb8e-9bfd4aa7f313 commented 15 years ago
comment:2

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.

85eec1a4-3d04-4b4d-b711-d4db03337c41 commented 15 years ago
comment:3

Merged in Sage 3.4.1.alpha0.

Cheers,

Michael

11d1fc49-71a1-44e1-869f-76be013245a0 commented 15 years ago

Reviewer: Minh Van Nguyen

11d1fc49-71a1-44e1-869f-76be013245a0 commented 15 years ago

Author: David Loeffler

11d1fc49-71a1-44e1-869f-76be013245a0 commented 15 years ago

Merged: 3.4.1.alpha0