From d92eadade4c3b6a477a14809adeac3c058458ad3 Mon Sep 17 00:00:00 2001 From: Jeroen Demeyer Date: Mon, 25 Apr 2016 13:34:34 +0200 Subject: [PATCH] Add documentation --- src/doc/en/developer/coding_basics.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/src/doc/en/developer/coding_basics.rst b/src/doc/en/developer/coding_basics.rst index 2d40bcb86b1..d94118f1305 100644 --- a/src/doc/en/developer/coding_basics.rst +++ b/src/doc/en/developer/coding_basics.rst @@ -308,7 +308,7 @@ information. You can use the existing functions of Sage as templates. REFERENCES: - .. [Nat2000] \M.B. Nathanson. Elementary Methods in Number Theory. + .. [Nat2000] \M. B. Nathanson. Elementary Methods in Number Theory. Springer, 2000. - A **NOTE** block for tips/tricks (optional). :: @@ -370,6 +370,13 @@ information. You can use the existing functions of Sage as templates. .. [SC] Conventions for coding in sage. http://www.sagemath.org/doc/developer/conventions.html. + When abbreviating the first name of an author, be sure to put a + backslash in front of it. This ensures that the letter (``C.`` + in the example below) will not be interpreted as a list + enumerator:: + + .. [Gauss] \C. F. Gauss, Disquisitiones Arithmeticae, 1801. + See the `Sphinx/ReST markup for citations `_. For links toward trac tickets or wikipedia, see :ref:`chapter-sage_manuals_links`. - A **TESTS** block (optional)