#20496 closed defect (fixed)

Escape abbreviated first names in references

Reported by: jdemeyer Owned by:
Priority: major Milestone: sage-7.2
Component: documentation Keywords:
Cc: hivert, strogdon Merged in:
Authors: Jeroen Demeyer Reviewers: Steven Trogdon
Report Upstream: N/A Work issues:
Branch: 581b9f6 (Commits) Commit: 581b9f6a61e21d2c043eccca1840378e11734117
Dependencies: Stopgaps:

Description (last modified by jdemeyer)

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.

Change History (13)

comment:1 Changed 14 months ago by jdemeyer

  • Description modified (diff)

comment:2 Changed 14 months ago by jdemeyer

  • Branch set to u/jdemeyer/escape_abbreviated_first_names_in_references

comment:3 Changed 14 months ago by jdemeyer

  • Cc hivert strogdon added
  • Commit set to d92eadade4c3b6a477a14809adeac3c058458ad3
  • Status changed from new to needs_review

New commits:

00722fdEscape abbreviated first names in references
d92eadaAdd documentation

comment:4 Changed 14 months ago by jhpalmieri

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.)

comment:5 follow-up: Changed 14 months ago by strogdon

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?

comment:6 Changed 14 months ago by jhpalmieri

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.

comment:7 Changed 14 months ago by jdemeyer

  • Status changed from needs_review to needs_work

comment:8 in reply to: ↑ 5 Changed 14 months ago by jdemeyer

Replying to strogdon:

Is it possible that one only has to be careful when the REFERENCE: paragraph has only one line?

Yes

But I agree that we should just add the backslash always, that's the simplest solution.

comment:9 Changed 14 months ago by git

  • Commit changed from d92eadade4c3b6a477a14809adeac3c058458ad3 to 581b9f6a61e21d2c043eccca1840378e11734117

Branch pushed to git repo; I updated commit sha1. New commits:

581b9f6More bibliography formatting fixes

comment:10 Changed 14 months ago by jdemeyer

  • Status changed from needs_work to needs_review

comment:11 Changed 14 months ago by jdemeyer

Something for a different ticket: we should be consistent between C. F. Gauss and C.F. Gauss.

comment:12 Changed 14 months ago by strogdon

  • Reviewers set to Steven Trogdon
  • Status changed from needs_review to positive_review

These changes work with #18497.

comment:13 Changed 14 months ago by vbraun

  • Branch changed from u/jdemeyer/escape_abbreviated_first_names_in_references to 581b9f6a61e21d2c043eccca1840378e11734117
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.