Visitar URL original
Move & revise section on installing and using pre-commit by namurphy · Pull Request #1651 · PlasmaPy/PlasmaPy · GitHub
Skip to content

Move & revise section on installing and using pre-commit - #1651

Merged
namurphy merged 6 commits into
PlasmaPy:mainfrom
namurphy:setup-pre-commit
Aug 2, 2022
Merged

namurphy merged 6 commits into
PlasmaPy:mainfrom
namurphy:setup-pre-commit

Conversation

@namurphy

@namurphy namurphy commented Jul 29, 2022 •

Copy link
Copy Markdown
Member

In #1305, I updated the section that describes how to use pre-commit in the coding guide. This PR takes that section and moves it to install_dev.rst, which I'm intending to update later.

I still have to...

  • Remove section on pre-commit from coding guide

@github-actions github-actions Bot added the docs PlasmaPy Docs at http://docs.plasmapy.org label Jul 29, 2022
@codecov

codecov Bot commented Jul 29, 2022 •

Copy link
Copy Markdown

Codecov Report

Merging #1651 (235e369) into main (28daa44) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1651   +/-   ##
=======================================
  Coverage   97.21%   97.21%           
=======================================
  Files          83       83           
  Lines        7962     7962           
=======================================
  Hits         7740     7740           
  Misses        222      222           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 28daa44...235e369. Read the comment docs.

@StanczakDominik StanczakDominik left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good rewrite, looks great, conditional on the two minor missing links in the doc tests finding themselves, of course ;)

Comment on lines +236 to +237
that says ``pre-commit.ci autofix``. After doing this, be sure to `pull
the changes`_ from GitHub to your computer with ``git pull``.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing a link, I suspect external?

* ``trailing-whitespace`` to remove trailing whitespace.
* black_ to format code.
* isort_ to sort imports.
* nbqa_ to format notebooks.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess we'd need https://github.com/nbQA-dev/nbQA in the common_links section for this to work!

@namurphy
namurphy marked this pull request as ready for review July 30, 2022 14:02
@namurphy
namurphy requested a review from rocco8773 August 2, 2022 19:05
@namurphy
namurphy merged commit 0fe9b3c into PlasmaPy:main Aug 2, 2022
@namurphy
namurphy deleted the setup-pre-commit branch August 2, 2022 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contributor guide docs PlasmaPy Docs at http://docs.plasmapy.org

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants