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

DOC: SciPy extensions for code style and docstring guidelines. #13955

Merged
merged 15 commits into from
Mar 24, 2022
Merged

DOC: SciPy extensions for code style and docstring guidelines. #13955

merged 15 commits into from
Mar 24, 2022

Commits on Jun 6, 2021

  1. DOC: SciPy extensions for code style and docstring guidelines. 

    [skip travis]
[skip actions]
[skip azp]
    @WarrenWeckesser
    WarrenWeckesser committed Jun 6, 2021
    Configuration menu
    Copy the full SHA
    98a4613 View commit details
    Browse the repository at this point in the history

  2. Remove rule about where the space goes when a long string is split.

    @WarrenWeckesser
    WarrenWeckesser committed Jun 6, 2021
    Configuration menu
    Copy the full SHA
    3ff0804 View commit details
    Browse the repository at this point in the history

  3. Remove rule about last line of docstring being a blank line.

    @WarrenWeckesser
    WarrenWeckesser committed Jun 6, 2021
    Configuration menu
    Copy the full SHA
    8780082 View commit details
    Browse the repository at this point in the history

  4. Add links to the NumPy Testing Guidelines. 

    [skip actions]
[skip travis]
[skip azp]
    @WarrenWeckesser
    WarrenWeckesser committed Jun 6, 2021
    Configuration menu
    Copy the full SHA
    f0be9b3 View commit details
    Browse the repository at this point in the history

Commits on Mar 22, 2022

  1. DOC: Update link to numpy's testing guidelines. 

    Co-authored-by: Melissa Weber Mendonça <melissawm@gmail.com>
    @WarrenWeckesser @melissawm
    WarrenWeckesser and melissawm committed Mar 22, 2022
    Configuration menu
    Copy the full SHA
    4eac26b View commit details
    Browse the repository at this point in the history

  2. DOC: Update link to numpy's testing guidelines. 

    Co-authored-by: Melissa Weber Mendonça <melissawm@gmail.com>
    @WarrenWeckesser @melissawm
    WarrenWeckesser and melissawm committed Mar 22, 2022
    Configuration menu
    Copy the full SHA
    a674d86 View commit details
    Browse the repository at this point in the history

  3. Remove section about the use of LaTeX. 

    If necessary, this can be hashed out in a follow-up PR.
    @WarrenWeckesser
    WarrenWeckesser committed Mar 22, 2022
    Configuration menu
    Copy the full SHA
    9b9b3b0 View commit details
    Browse the repository at this point in the history

  4. Remove section about the recommended Python name to use for 'lambda'. 

    If necessary, this can be hashed out in a follow-up PR.
    @WarrenWeckesser
    WarrenWeckesser committed Mar 22, 2022
    Configuration menu
    Copy the full SHA
    134232f View commit details
    Browse the repository at this point in the history

  5. In the 'must, not should' examples, use backticks around x.

    @WarrenWeckesser
    WarrenWeckesser committed Mar 22, 2022
    Configuration menu
    Copy the full SHA
    22ddb43 View commit details
    Browse the repository at this point in the history

  6. Add recommendation to use DOIs in references.

    @WarrenWeckesser
    WarrenWeckesser committed Mar 22, 2022
    Configuration menu
    Copy the full SHA
    43c5d6c View commit details
    Browse the repository at this point in the history

  7. Decide that 'versionadded' for new parameters goes in the Parameters … 

    …section.
    @WarrenWeckesser
    WarrenWeckesser committed Mar 22, 2022
    Configuration menu
    Copy the full SHA
    518be54 View commit details
    Browse the repository at this point in the history

  8. Trivial whitespace fix. 

    [skip azp] [skip actions]
    @WarrenWeckesser
    WarrenWeckesser committed Mar 22, 2022
    Configuration menu
    Copy the full SHA
    eefe045 View commit details
    Browse the repository at this point in the history

  9. Merge branch 'main' into guide-missing-bits 

    [skip azp] [skip actions]
    @WarrenWeckesser
    WarrenWeckesser committed Mar 22, 2022
    Configuration menu
    Copy the full SHA
    a484c69 View commit details
    Browse the repository at this point in the history

  10. Fix Sphinx markup so the sample reference is a literal block. 

    [skip azp] [skip actions]
    @WarrenWeckesser
    WarrenWeckesser committed Mar 22, 2022
    Configuration menu
    Copy the full SHA
    1794b92 View commit details
    Browse the repository at this point in the history

  11. Remove the guidelines about the use of 'import numpy as np' in examples. 

    There is ongoing discussion in scipygh-13049.  We can add the appropriate guideline once that issue is officially resolved.

Co-authored-by: Matt Haberland <mhaberla@calpoly.edu>
    @WarrenWeckesser @mdhaber
    WarrenWeckesser and mdhaber committed Mar 22, 2022
    Configuration menu
    Copy the full SHA
    a2a2aeb View commit details
    Browse the repository at this point in the history