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

Fix docstring syntax errors #1312

Merged
merged 7 commits into from
Jun 22, 2020
Merged

Fix docstring syntax errors #1312

merged 7 commits into from
Jun 22, 2020

Commits on Jun 21, 2020

  1. Fix typos in L{} docstring tags

    @mthuurne
    mthuurne committed Jun 21, 2020
    Configuration menu
    Copy the full SHA
    e0ecc44 View commit details
    Browse the repository at this point in the history

  2. Escape \n in docstrings 

    Since docstrings are strings, a '\n' will insert a newline. If the
documentation should read '\n', the backslash should be escaped.
    @mthuurne
    mthuurne committed Jun 21, 2020
    Configuration menu
    Copy the full SHA
    1b9cdeb View commit details
    Browse the repository at this point in the history

  3. Indent bullet list in docstring 

    The epytext syntax requires a list to be indented.
    @mthuurne
    mthuurne committed Jun 21, 2020
    Configuration menu
    Copy the full SHA
    38e9df6 View commit details
    Browse the repository at this point in the history

  4. Put code example in a literal block 

    Otherwise the epytext parser will complain about the indentation.
    @mthuurne
    mthuurne committed Jun 21, 2020
    Configuration menu
    Copy the full SHA
    a4f1875 View commit details
    Browse the repository at this point in the history

  5. Add empty news fragment

    @mthuurne
    mthuurne committed Jun 21, 2020
    Configuration menu
    Copy the full SHA
    19c9e1e View commit details
    Browse the repository at this point in the history

  6. Fix code layout issues flagged by lint 

    These are in close proximity to, but not actually part of, the changed
docstrings.
    @mthuurne
    mthuurne committed Jun 21, 2020
    Configuration menu
    Copy the full SHA
    36b0443 View commit details
    Browse the repository at this point in the history

Commits on Jun 22, 2020

  1. Merge branch 'trunk' into 9868-mthuurne-baddocstring

    @mthuurne
    mthuurne committed Jun 22, 2020
    Configuration menu
    Copy the full SHA
    1adb810 View commit details
    Browse the repository at this point in the history