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

Document, lint, and fix placement of magic comments in multiline doctests #35181

Merged
merged 14 commits into from
Apr 1, 2023
Merged

Document, lint, and fix placement of magic comments in multiline doctests #35181

merged 14 commits into from
Apr 1, 2023

Commits on Mar 27, 2023

  1. Trac sagemath#33091: fix mislabeled multiline "long time" tests. 

    There are a few tests in the sage library that span multiple lines and
that were intended to be marked as "long time", but were not due to an
implementation detail. As it stands, it is the FIRST line of a doctest
that needs to be marked "long time", and not the last.

This commit fixes a few doctests whose last (but not first) lines were
tagged, updating them instead to bear the "# long time" tag on each
line. This is overkill, but will save us time in the event that the
parser is ever changed.
    @orlitzky @mkoeppe
    orlitzky authored and mkoeppe committed Mar 27, 2023
    Configuration menu
    Copy the full SHA
    0888f7a View commit details
    Browse the repository at this point in the history

  2. src/doc/en/developer/coding_basics.rst: Explain where doctest markers… 

    … go in multiline tests
    @mkoeppe
    mkoeppe committed Mar 27, 2023
    Configuration menu
    Copy the full SHA
    6ca1f95 View commit details
    Browse the repository at this point in the history

  3. src/.relint.yml (multiline_doctest_comment): New

    @mkoeppe
    mkoeppe committed Mar 27, 2023
    Configuration menu
    Copy the full SHA
    297cc2e View commit details
    Browse the repository at this point in the history

  4. git grep -E -l '[.][.][.][.]:.*#' | xargs sed -E -i.bak '/^ *[.][.][.… 

    …][.].*#/s/ *# *(arb216|arb218|py2|py3|long time|not implemented|not tested|known bug|optional|indirect doctest).*//'
    @mkoeppe
    mkoeppe committed Mar 27, 2023
    Configuration menu
    Copy the full SHA
    9cc7c19 View commit details
    Browse the repository at this point in the history

  5. Restore lost # indirect doctest

    @mkoeppe
    mkoeppe committed Mar 27, 2023
    Configuration menu
    Copy the full SHA
    32c910f View commit details
    Browse the repository at this point in the history

  6. src/doc/pt/tutorial/interfaces.rst: Fix indentation in doctests

    @mkoeppe
    mkoeppe committed Mar 27, 2023
    Configuration menu
    Copy the full SHA
    f660705 View commit details
    Browse the repository at this point in the history

  7. Restore lost # indirect doctest, # known bug

    @mkoeppe
    mkoeppe committed Mar 27, 2023
    Configuration menu
    Copy the full SHA
    7dd8336 View commit details
    Browse the repository at this point in the history

  8. src/doc/en/developer/coding_basics.rst: Expand an example, add doctes… 

    …t output
    @mkoeppe
    mkoeppe committed Mar 27, 2023
    Configuration menu
    Copy the full SHA
    78608c6 View commit details
    Browse the repository at this point in the history

  9. src/doc/en/developer/coding_basics.rst: Refer to python reference for… 

    … 'physical line'
    @mkoeppe
    mkoeppe committed Mar 27, 2023
    Configuration menu
    Copy the full SHA
    9377f4c View commit details
    Browse the repository at this point in the history

  10. src/doc/en/developer/coding_basics.rst: Fix RST markup

    @mkoeppe
    mkoeppe committed Mar 27, 2023
    Configuration menu
    Copy the full SHA
    7d0b783 View commit details
    Browse the repository at this point in the history

  11. src/sage/interfaces/kenzo.py: Fix up doctest markup

    @mkoeppe
    mkoeppe committed Mar 27, 2023
    Configuration menu
    Copy the full SHA
    32c9b63 View commit details
    Browse the repository at this point in the history

  12. Fix magic comments in multiline doctests

    @mkoeppe
    mkoeppe committed Mar 27, 2023
    Configuration menu
    Copy the full SHA
    116774e View commit details
    Browse the repository at this point in the history

  13. src/sage/geometry/polyhedron/backend_normaliz.py: Fix typo

    @mkoeppe
    mkoeppe committed Mar 27, 2023
    Configuration menu
    Copy the full SHA
    884cece View commit details
    Browse the repository at this point in the history

  14. src/sage/combinat/root_system/reflection_group_element.pyx: Fix # opt… 

    …ional tags
    @mkoeppe
    mkoeppe committed Mar 27, 2023
    Configuration menu
    Copy the full SHA
    2861163 View commit details
    Browse the repository at this point in the history