Escape abbreviated first names in references

jdemeyer commented 8 years ago

This is incorrect docutils markup:

.. [2] E. Assmus, J. Key, Designs and their codes, CUP, 1992.

because the E. is interpreted as list item. It should be

.. [2] \E. Assmus, J. Key, Designs and their codes, CUP, 1992.

CC: @hivert @strogdon

Component: documentation

Author: Jeroen Demeyer

Branch/Commit: 581b9f6

Reviewer: Steven Trogdon

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

jdemeyer commented 8 years ago

Description changed:

--- 
+++ 
@@ -3,8 +3,7 @@

.. [2] E. Assmus, J. Key, Designs and their codes, CUP, 1992.

-because the `E.` is interpreted as list item.
-it should be
+because the `E.` is interpreted as list item. It should be

.. [2] \E. Assmus, J. Key, Designs and their codes, CUP, 1992.

jdemeyer commented 8 years ago

Branch: u/jdemeyer/escape_abbreviated_first_names_in_references

jdemeyer commented 8 years ago

New commits:

`00722fd`	`Escape abbreviated first names in references`
`d92eada`	`Add documentation`

jdemeyer commented 8 years ago

Commit: d92eada

jhpalmieri commented 8 years ago

comment:4

I found some other places that may need fixes:

combinat/descent_algebra.py:76:    .. [MR-Desc] C. Malvenuto, C. Reutenauer, *Duality between
combinat/gray_codes.py:6:.. [Knuth-TAOCP2A] D. Knuth "The art of computer programming", fascicules 2A,
combinat/gray_codes.py:9:.. [Knuth-TAOCP3A] D. Knuth "The art of computer programming", fascicule 3A
combinat/designs/difference_family.py:16:.. [BJL99-1] T. Beth, D. Jungnickel, H. Lenz "Design theory Vol. I."
combinat/designs/difference_family.py:20:.. [BLJ99-2] T. Beth, D. Jungnickel, H. Lenz "Design theory Vol. II."
combinat/root_system/non_symmetric_macdonald_polynomials.py:345:    .. [Haiman ICM] M. Haiman, Cherednik algebras, Macdonald polynomials and combinatorics,
combinat/sf/new_kschur.py:666:            .. [SZ.2001] M. Shimozono, M. Zabrocki,
functions/bessel.py:159:.. [AS-Bessel] F. W. J. Olver: 9. Bessel Functions of Integer Order, in Abramowitz and Stegun: Handbook of Mathematical Functions
functions/bessel.py:161:.. [AS-Struve] M. Abramowitz: 12. Struve Functions and Related Functions, in Abramowitz and Stegun: Handbook of Mathematical Functions
functions/bessel.py:163:.. [DLMF-Bessel] F. W. J. Olver and L. C. Maximon: 10. Bessel Functions, in NIST Digital Library of Mathematical Functions
functions/bessel.py:165:.. [DLMF-Struve] R. B. Paris: 11. Struve and Related Functions, in NIST Digital Library of Mathematical Functions
geometry/cone.py:4827:        .. [Gowda-Tao] M.S. Gowda and J. Tao. On the bilinearity rank of
graphs/distances_all_pairs.pyx:120:.. [CGH+13] P. Crescenzi, R. Grossi, M. Habib, L. Lanzi, A. Marino. On computing
graphs/distances_all_pairs.pyx:124:.. [CGI+10] P. Crescenzi, R. Grossi, C. Imbrenda, L. Lanzi, and A. Marino.
groups/perm_gps/permgroup.py:2218:        .. [THOMAS-WOODS] A.D. Thomas and G.V. Wood, Group Tables (Exeter: Shiva Publishing, 1980)
homology/chain_homotopy.py:36:.. [M-AR] H. Molina-Abril and P. Réal, *Homology computation using spanning
homology/chain_homotopy.py:45:.. [RM-A] P. Réal and H. Molina-Abril, *Cell AT-models for digital
homology/homology_vector_space_with_basis.py:10:.. [G-DR03] R. González-Díaz and P. Réal, *Computation of cohomology
homology/homology_vector_space_with_basis.py:14:.. [G-DR99] R. González-Díaz and P. Réal, *A combinatorial method for
lfunctions/zero_sums.pyx:1735:        .. [Bob-13] J.W. Bober. Conditionally bounding analytic ranks of elliptic curves.
matrix/matrix2.pyx:13999:        .. [STORJOHANN-THESIS] A. Storjohann, Algorithms
matrix/matrix2.pyx:14004:        .. [STORJOHANN-ISACC98] A. Storjohann, An O(n^3)
matrix/matrix2.pyx:14396:        .. [STORJOHANN-EMAIL] A. Storjohann, Email Communication. 30 May 2011.
modular/dirichlet.py:656:        .. [Cohen-II] H. Cohen, Number Theory and Diophantine
modular/dirichlet.py:660:        .. [Diamond-Im] F. Diamond and J. Im, Modular forms and
modular/modform/element.py:1725:        .. [Atkin-Li] A. O. L. Atkin and Wen-Ch'ing Winnie Li, Twists
schemes/projective/endPN_minimal_model.py:14:.. [Bruin-Molnar] N. Bruin and A. Molnar, *Minimal models for rational
schemes/projective/projective_morphism.py:4545:        .. [Hutz-gr] B. Hutz. Good reduction of periodic points, Illinois Journal of

(You must have done a regexp search that didn't look for citation keys including hyphens, spaces, or other characters. I don't think that spaces, as in [Haiman ICM], are valid markup, actually. Hyphens, periods, and plus signs are all okay. See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#reference-names.)

strogdon commented 8 years ago

comment:5

One would think that some of the above would present a problem, but I have no build issues with the pdf-docs for #18497. Is it possible that one only has to be careful when the REFERENCE: paragraph has only one line?

jhpalmieri commented 8 years ago

comment:6

I think the best long term solution is to adopt the proposed (and documented) change: put a backslash in front of the first initial of the first author. It may not always be necessary, but figuring out and documenting when it is or is not may be too complicated to be worth it.

jdemeyer commented 8 years ago

comment:8

Replying to @strogdon: