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/coding #34170

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

Fix docstring markup in sage/coding #34170

kwankyu opened this issue Jul 12, 2022 · 21 comments

Comments

@kwankyu
Copy link
Collaborator

kwankyu commented Jul 12, 2022

Part of #34157:

sage/coding/gabidulin_code.py:534:1: RST218 Literal block expected; none found.
sage/coding/ag_code.py:35:1: RST303 Unknown directive type "toctree".
sage/coding/self_dual_codes.py:228:1: RST218 Literal block expected; none found.
sage/coding/linear_code_no_metric.py:755:1: RST204 Enumerated list ends without a blank line; unexpected unindent.
sage/coding/grs_code.py:1201:1: RST202 Bullet list ends without a blank line; unexpected unindent.
sage/coding/grs_code.py:1201:1: RST213 Inline emphasis start-string without end-string.
sage/coding/guruswami_sudan/interpolation.py:41:1: RST218 Literal block expected; none found.

Depends on #30448
Depends on #34167

CC: @jhpalmieri @fchapoton

Component: documentation

Author: Frédéric Chapoton, Matthias Koeppe

Branch/Commit: eeb6448

Reviewer: John Palmieri

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

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

This comment has been minimized.

@fchapoton
Copy link
Contributor

Branch: u/chapoton/34170

@fchapoton
Copy link
Contributor

Commit: 7131f7f

@fchapoton
Copy link
Contributor

comment:2

do not know what to do with the unknown directive toctree


New commits:

7131f7frst fixes in coding

@mkoeppe
Copy link
Contributor

mkoeppe commented Jul 13, 2022

comment:3

I can just make it known to the linter. Here or on a separate ticket?

@fchapoton
Copy link
Contributor

comment:4

but toctree appears in other places, and I have not seen any other problem with it elsewhere

maybe the problem here is just before the content is not indented correctly ? (NO.)

EDIT: in fact, it's really the only occurrence of toctree in src/sage

BUT there are many toctree in src/doc ; by the way should we validate them too ?

@mkoeppe
Copy link
Contributor

mkoeppe commented Jul 13, 2022

Changed branch from u/chapoton/34170 to u/mkoeppe/34170

@mkoeppe
Copy link
Contributor

mkoeppe commented Jul 13, 2022

Changed commit from 7131f7f to c738bb0

@mkoeppe
Copy link
Contributor

mkoeppe commented Jul 13, 2022

Dependencies: #30448

@mkoeppe
Copy link
Contributor

mkoeppe commented Jul 13, 2022

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
77ee556Merge #30448
c738bb0src/tox.ini [flake8]: Add toctree to rst-directives

@mkoeppe
Copy link
Contributor

mkoeppe commented Jul 13, 2022

comment:7

Replying to @fchapoton:

EDIT: in fact, it's really the only occurrence of toctree in src/sage

I've added it to the list of known directives

BUT there are many toctree in src/doc ; by the way should we validate them too ?

I've opened #34178 for this.

@mkoeppe
Copy link
Contributor

mkoeppe commented Jul 16, 2022

Author: Matthias Koeppe

@mkoeppe
Copy link
Contributor

mkoeppe commented Jul 16, 2022

Changed dependencies from #30448 to #30448, #34167

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jul 16, 2022

Changed commit from c738bb0 to eeb6448

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jul 16, 2022

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

b37c1derst fixes in geometry matroids modules
918dfcdMerge branch 't/30448/public/30448' into t/34167/34167
ecd5e1atrac 34167: add MODULEAUTHOR, autofunction to the list of known directives
eeb6448Merge #34167

@mkoeppe
Copy link
Contributor

mkoeppe commented Jul 16, 2022

comment:11

merged #34167 to resolve merge conflict

@jhpalmieri
Copy link
Member

Reviewer: John Palmieri

@jhpalmieri
Copy link
Member

Changed author from Matthias Koeppe to Frédéric Chapoton, Matthias Koeppe

@jhpalmieri
Copy link
Member

comment:12

Let's merge it!

@mkoeppe
Copy link
Contributor

mkoeppe commented Jul 16, 2022

comment:13

Thanks

@vbraun
Copy link
Member

vbraun commented Aug 7, 2022

Changed branch from u/mkoeppe/34170 to eeb6448

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

5 participants