From 3ffc753a230bce1f29893554069a4eb95405a8a9 Mon Sep 17 00:00:00 2001 From: Giorgos Mousa Date: Fri, 24 May 2024 12:36:16 +0000 Subject: [PATCH 1/4] Correct developer guide's function template Spaced tuples --- src/doc/en/developer/coding_basics.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/doc/en/developer/coding_basics.rst b/src/doc/en/developer/coding_basics.rst index 8522fca3b9f..d94d864a4be 100644 --- a/src/doc/en/developer/coding_basics.rst +++ b/src/doc/en/developer/coding_basics.rst @@ -649,7 +649,7 @@ indentation: def point(self, x=1, y=2): r""" - Return the point `(x^5,y)`. + Return the point `(x^5, y)`. INPUT: @@ -668,17 +668,17 @@ indentation: This example illustrates ... :: sage: A = ModuliSpace() - sage: A.point(2,3) + sage: A.point(2, 3) xxx We now ... :: - sage: B = A.point(5,6) + sage: B = A.point(5, 6) sage: xxx It is an error to ... :: - sage: C = A.point('x',7) + sage: C = A.point('x', 7) Traceback (most recent call last): ... TypeError: unable to convert 'r' to an integer From b369f357d4444fe67802515161635540e0ef5dc8 Mon Sep 17 00:00:00 2001 From: Giorgos Mousa Date: Fri, 24 May 2024 18:33:35 +0000 Subject: [PATCH 2/4] Replace xxx with dots --- src/doc/en/developer/coding_basics.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/doc/en/developer/coding_basics.rst b/src/doc/en/developer/coding_basics.rst index d94d864a4be..4be87f0c9c2 100644 --- a/src/doc/en/developer/coding_basics.rst +++ b/src/doc/en/developer/coding_basics.rst @@ -653,12 +653,12 @@ indentation: INPUT: - - ``x`` -- integer (default: `1`); the description of the + - ``x`` -- integer (default: ``1``); the description of the argument ``x`` goes here. If it contains multiple lines, all the lines after the first need to begin at the same indentation as the backtick. - - ``y`` -- integer (default: `2`); the description of the + - ``y`` -- integer (default: ``2``); the description of the argument ``y`` OUTPUT: the point as a tuple @@ -669,19 +669,19 @@ indentation: sage: A = ModuliSpace() sage: A.point(2, 3) - xxx + ... We now ... :: sage: B = A.point(5, 6) - sage: xxx + sage: ... It is an error to ... :: sage: C = A.point('x', 7) Traceback (most recent call last): ... - TypeError: unable to convert 'r' to an integer + TypeError: unable to convert 'x' to an integer .. NOTE:: @@ -696,8 +696,8 @@ indentation: TESTS:: - sage: A.point(42, 0) # Check for corner case y=0 - xxx + sage: A.point(42, 0) # Check for corner case y = 0 + ... """ From 86e7cb38f3d3def4d0ac4d37aac16e1e8e1b1546 Mon Sep 17 00:00:00 2001 From: Giorgos Mousa Date: Fri, 24 May 2024 18:43:02 +0000 Subject: [PATCH 3/4] Change note --- src/doc/en/developer/coding_basics.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/doc/en/developer/coding_basics.rst b/src/doc/en/developer/coding_basics.rst index 4be87f0c9c2..7e8ac0f2ba6 100644 --- a/src/doc/en/developer/coding_basics.rst +++ b/src/doc/en/developer/coding_basics.rst @@ -685,8 +685,8 @@ indentation: .. NOTE:: - This function uses the algorithm of [BCDT2001]_ to determine - whether an elliptic curve `E` over `Q` is modular. + This function uses :func:`pow` to determine the fifth + power of ``x``. ... From ce843488b057f96e7040fcd9c76f88254607d21d Mon Sep 17 00:00:00 2001 From: Giorgos Mousa Date: Fri, 24 May 2024 19:15:18 +0000 Subject: [PATCH 4/4] Edit examples --- src/doc/en/developer/coding_basics.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/doc/en/developer/coding_basics.rst b/src/doc/en/developer/coding_basics.rst index 7e8ac0f2ba6..0855f04c5ec 100644 --- a/src/doc/en/developer/coding_basics.rst +++ b/src/doc/en/developer/coding_basics.rst @@ -661,15 +661,15 @@ indentation: - ``y`` -- integer (default: ``2``); the description of the argument ``y`` - OUTPUT: the point as a tuple + OUTPUT: tuple; further description of the output EXAMPLES: This example illustrates ... :: - sage: A = ModuliSpace() + sage: A = EuclideanSpace(2) sage: A.point(2, 3) - ... + (32, 3) We now ... ::