Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Correct developer guide's function template #38068

Merged
merged 5 commits into from
Jun 1, 2024
Merged

Correct developer guide's function template #38068

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3ffc753
Correct developer guide's function template
gmou3 May 24, 2024
b369f35
Replace xxx with dots
gmou3 May 24, 2024
86e7cb3
Change note
gmou3 May 24, 2024
ce84348
Edit examples
gmou3 May 24, 2024
a3a1a9f
Merge branch 'develop' into developer_guide_function_template
gmou3 May 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions src/doc/en/developer/coding_basics.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -649,44 +649,44 @@ indentation:

def point(self, x=1, y=2):
r"""
Return the point `(x^5,y)`.
Return the point `(x^5, y)`.

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
kwankyu marked this conversation as resolved.
Show resolved Hide resolved
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``
kwankyu marked this conversation as resolved.
Show resolved Hide resolved

OUTPUT: the point as a tuple
OUTPUT: tuple; further description of the output

EXAMPLES:

This example illustrates ... ::

sage: A = ModuliSpace()
sage: A.point(2,3)
xxx
sage: A = EuclideanSpace(2)
sage: A.point(2, 3)
(32, 3)

kwankyu marked this conversation as resolved.
Show resolved Hide resolved
We now ... ::

sage: B = A.point(5,6)
sage: xxx
sage: B = A.point(5, 6)
sage: ...

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
TypeError: unable to convert 'x' to an integer

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

kwankyu marked this conversation as resolved.
Show resolved Hide resolved
...

Expand All @@ -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
...
"""
<body of the function>

Expand Down
Loading