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.

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

Fix docstring markup in sage/schemes #34160

Closed
kwankyu opened this issue Jul 12, 2022 · 23 comments
Closed

Fix docstring markup in sage/schemes #34160

kwankyu opened this issue Jul 12, 2022 · 23 comments

Comments

@kwankyu
Copy link
Collaborator

kwankyu commented Jul 12, 2022

Part of #34157:

sage/schemes/cyclic_covers/cycliccover_finite_field.py:857:1: RST202 Bullet list ends without a blank line; unexpected unindent.
sage/schemes/elliptic_curves/gal_reps_number_field.py:574:1: RST214 Inline literal start-string without end-string.
sage/schemes/elliptic_curves/period_lattice.py:144:1: RST202 Bullet list ends without a blank line; unexpected unindent.
sage/schemes/elliptic_curves/period_lattice.py:147:1: RST202 Bullet list ends without a blank line; unexpected unindent.
sage/schemes/elliptic_curves/ell_number_field.py:737:1: RST219 Inline substitution_reference start-string without end-string.
sage/schemes/elliptic_curves/ell_rational_field.py:6422:1: RST301 Unexpected indentation.
sage/schemes/elliptic_curves/padics.py:1660:1: RST215 Inline interpreted text or phrase reference start-string without end-string.
sage/schemes/elliptic_curves/padics.py:1665:1: RST301 Unexpected indentation.
sage/schemes/elliptic_curves/padics.py:1666:1: RST201 Block quote ends without a blank line; unexpected unindent.
sage/schemes/elliptic_curves/isogeny_class.py:99:1: RST215 Inline interpreted text or phrase reference start-string without end-string.
sage/schemes/riemann_surfaces/riemann_surface.py:1560:1: RST301 Unexpected indentation.
sage/schemes/curves/zariski_vankampen.py:734:1: RST202 Bullet list ends without a blank line; unexpected unindent.

Component: documentation

Author: Frédéric Chapoton

Branch/Commit: 92d28b3

Reviewer: Kwankyu Lee, Matthias Koeppe

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

@kwankyu kwankyu added this to the sage-9.7 milestone Jul 12, 2022
@kwankyu

This comment has been minimized.

@fchapoton
Copy link
Contributor

comment:2

my tentative, not checked


New commits:

7b1b937rst fixes in schemes

@fchapoton
Copy link
Contributor

Branch: u/chapoton/34160

@fchapoton
Copy link
Contributor

Commit: 7b1b937

@fchapoton
Copy link
Contributor

Author: Frédéric Chapoton

@mkoeppe
Copy link
Contributor

mkoeppe commented Jul 12, 2022

comment:3

with #30448 merged:

$ tox -e rst src/sage/schemes
...
  rst: commands succeeded
  congratulations :)

@kwankyu
Copy link
Collaborator Author

kwankyu commented Jul 13, 2022

Changed branch from u/chapoton/34160 to u/klee/34160

@kwankyu
Copy link
Collaborator Author

kwankyu commented Jul 13, 2022

Changed commit from 7b1b937 to none

@kwankyu
Copy link
Collaborator Author

kwankyu commented Jul 13, 2022

Changed branch from u/klee/34160 to public/34160

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jul 13, 2022

Branch pushed to git repo; I updated commit sha1. Last 10 new commits:

dccceb4src/sage/parallel: Fix errors shown by tox -e rst
4cc5674src/sage/quadratic_forms: Fix errors shown by tox -e rst
a2f5ef6src/sage/repl: Fix some errors shown by tox -e rst
c2d0a91src/sage/rings: Fix some errors shown by tox -e rst
8fc8776src/sage/structure: Fix errors shown by tox -e rst
18121fesrc/sage/modules: Fix errors shown by tox -e rst
d66c66e.github/workflows/lint.yml: Do not fail when rst checks fail
0677319Fix a typo
ef821e7Merge branch 't/30448/src_tox_ini__add_validation_of_rst_files_and_docstrings' into t/34160/34160
a9951bbAdd - before th

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jul 13, 2022

Commit: a9951bb

@kwankyu
Copy link
Collaborator Author

kwankyu commented Jul 13, 2022

Reviewer: Kwankyu Lee, Matthias Koeppe

@kwankyu
Copy link
Collaborator Author

kwankyu commented Jul 13, 2022

Dependencies: #30448

@kwankyu
Copy link
Collaborator Author

kwankyu commented Jul 13, 2022

comment:7

Sorry for messing up commit lists...

Positive review when the ticket is ready for review :)

@fchapoton
Copy link
Contributor

comment:8

merging with #30448 is not necessary, and makes the ticket un-reviewable

@kwankyu
Copy link
Collaborator Author

kwankyu commented Jul 13, 2022

comment:9

Replying to @fchapoton:

merging with #30448 is not necessary,

Right. When I upload the last commit "Add - before th", I accidentally merged #30448 to the branch here.

and makes the ticket un-reviewable.

If you set the ticket to "needs review" and is okay with the last commit, then I will give positive view.

@kwankyu
Copy link
Collaborator Author

kwankyu commented Jul 13, 2022

comment:10

In the last commit, only this is significant:

diff --git a/src/sage/schemes/elliptic_curves/isogeny_class.py b/src/sage/schemes/elliptic_curves/isogeny_class.py
index 340a771..2178273 100644
--- a/src/sage/schemes/elliptic_curves/isogeny_class.py
+++ b/src/sage/schemes/elliptic_curves/isogeny_class.py
@@ -97,7 +97,7 @@ class IsogenyClass_EC(SageObject):
 
     def __getitem__(self, i):
         """
-        Return the `i` th curve in the class.
+        Return the `i`-th curve in the class.
 
         EXAMPLES::

Other changes just remove white spaces.

@fchapoton
Copy link
Contributor

comment:11

ok, I understand. Seems to be good to go.

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jul 13, 2022

Changed commit from a9951bb to 92d28b3

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jul 13, 2022

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

92d28b3Add - before th

@kwankyu
Copy link
Collaborator Author

kwankyu commented Jul 13, 2022

Changed dependencies from #30448 to none

@kwankyu
Copy link
Collaborator Author

kwankyu commented Jul 13, 2022

comment:13

Thank you!

@vbraun
Copy link
Member

vbraun commented Jul 28, 2022

Changed branch from public/34160 to 92d28b3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants