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/interfaces #34163

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

Fix docstring markup in sage/interfaces #34163

kwankyu opened this issue Jul 12, 2022 · 15 comments

Comments

@kwankyu
Copy link
Collaborator

kwankyu commented Jul 12, 2022

Part of #34157:

sage/interfaces/qepcad.py:631:1: RST205 Explicit markup ends without a blank line; unexpected unindent.
sage/interfaces/qepcad.py:635:1: RST218 Literal block expected; none found.
sage/interfaces/polymake.py:456:1: RST201 Block quote ends without a blank line; unexpected unindent.
sage/interfaces/jmoldata.py:35:1: RST303 Unknown directive type "todo".
sage/interfaces/frobby.py:365:1: RST218 Literal block expected; none found.
sage/interfaces/interface.py:257:1: RST301 Unexpected indentation.
sage/interfaces/interface.py:258:1: RST201 Block quote ends without a blank line; unexpected unindent.
sage/interfaces/interface.py:448:1: RST213 Inline emphasis start-string without end-string.
sage/interfaces/mathics.py:983:1: RST301 Unexpected indentation.
sage/interfaces/mathics.py:984:1: RST202 Bullet list ends without a blank line; unexpected unindent.
sage/interfaces/mathics.py:987:1: RST301 Unexpected indentation.
sage/interfaces/mathics.py:988:1: RST201 Block quote ends without a blank line; unexpected unindent.
sage/interfaces/mathics.py:995:1: RST301 Unexpected indentation.
sage/interfaces/r.py:301:1: RST218 Literal block expected; none found.
sage/interfaces/r.py:340:1: RST301 Unexpected indentation.
sage/interfaces/r.py:507:1: RST218 Literal block expected; none found.
sage/interfaces/r.py:1393:1: RST202 Bullet list ends without a blank line; unexpected unindent.
sage/interfaces/r.py:2076:1: RST201 Block quote ends without a blank line; unexpected unindent.
sage/interfaces/r.py:2078:1: RST301 Unexpected indentation.
sage/interfaces/ecm.py:358:1: RST201 Block quote ends without a blank line; unexpected unindent.
sage/interfaces/ecm.py:388:1: RST301 Unexpected indentation.
sage/interfaces/ecm.py:389:1: RST201 Block quote ends without a blank line; unexpected unindent.
sage/interfaces/ecm.py:391:1: RST301 Unexpected indentation.
sage/interfaces/mathematica.py:416:1: RST218 Literal block expected; none found.
sage/interfaces/mathematica.py:729:1: RST301 Unexpected indentation.
sage/interfaces/mathematica.py:730:1: RST202 Bullet list ends without a blank line; unexpected unindent.
sage/interfaces/mathematica.py:733:1: RST301 Unexpected indentation.
sage/interfaces/mathematica.py:734:1: RST201 Block quote ends without a blank line; unexpected unindent.
sage/interfaces/mathematica.py:741:1: RST301 Unexpected indentation.
sage/interfaces/mupad.py:168:1: RST201 Block quote ends without a blank line; unexpected unindent.
sage/interfaces/giac.py:919:1: RST218 Literal block expected; none found.
sage/interfaces/giac.py:1069:1: RST301 Unexpected indentation.
sage/interfaces/giac.py:1070:1: RST202 Bullet list ends without a blank line; unexpected unindent.
sage/interfaces/magma.py:2631:1: RST218 Literal block expected; none found.
sage/interfaces/phc.py:505:1: RST201 Block quote ends without a blank line; unexpected unindent.

Component: documentation

Author: Frédéric Chapoton

Branch/Commit: c79ff66

Reviewer: Kwankyu Lee

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

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

This comment has been minimized.

@fchapoton
Copy link
Contributor

Author: Frédéric Chapoton

@fchapoton
Copy link
Contributor

Branch: u/chapoton/34163

@fchapoton
Copy link
Contributor

Commit: 8f13a5a

@fchapoton
Copy link
Contributor

comment:2

first tentative, not tested


New commits:

8f13a5arst fixes in interfaces/

@kwankyu
Copy link
Collaborator Author

kwankyu commented Jul 13, 2022

comment:3

Tested with #30448:

$ ./sage -tox -e rst src/sage/interfaces
...
sage/interfaces/r.py:2075:1: RST201 Block quote ends without a blank line; unexpected unindent.
sage/interfaces/r.py:2077:1: RST301 Unexpected indentation.

@kwankyu
Copy link
Collaborator Author

kwankyu commented Jul 13, 2022

comment:4

Perhaps new:

sage -t --warn-long 38.3 src/sage/interfaces/mupad.py
**********************************************************************
File "src/sage/interfaces/mupad.py", line 167, in sage.interfaces.mupad.Mupad._read_in_file_command
Failed example:
    with open(filename, 'w') as f:
        f.write('x := 2;\n')
Expected nothing
Got:
    8
**********************************************************************

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jul 13, 2022

Changed commit from 8f13a5a to c79ff66

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jul 13, 2022

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

c79ff66fix details

@fchapoton
Copy link
Contributor

comment:6

both fixed now

@kwankyu
Copy link
Collaborator Author

kwankyu commented Jul 13, 2022

comment:7

Test passed:

$ ./sage -tox -e rst src/sage/interfaces
rst installed: docutils==0.19,flake8==4.0.1,flake8-rst-docstrings==0.2.6,mccabe==0.6.1,pycodestyle==2.8.0,pyflakes==2.4.0,Pygments==2.12.0,restructuredtext-lint==1.4.0
rst run-test-pre: PYTHONHASHSEED='2172514036'
rst run-test: commands[0] | flake8 --select=RST sage/interfaces
___________________________________ summary ____________________________________
  rst: commands succeeded
  congratulations :)

@kwankyu
Copy link
Collaborator Author

kwankyu commented Jul 13, 2022

comment:8

Doctest also passed!

@kwankyu
Copy link
Collaborator Author

kwankyu commented Jul 15, 2022

Reviewer: Kwankyu Lee

@kwankyu
Copy link
Collaborator Author

kwankyu commented Jul 15, 2022

comment:10

LGTM.

@vbraun
Copy link
Member

vbraun commented Jul 28, 2022

Changed branch from u/chapoton/34163 to c79ff66

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

3 participants