Skip to content

Commit

Permalink
updated pre-commit instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryan Frederich authored and Ryan Frederich committed Jul 19, 2024
1 parent 3a39735 commit 2eecd04
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/cheat_sheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ When developing, these commands may come in handy:
| -------- | ------- |
| `sudo ss -lptn 'sport = :<port>'` | List the processes running on port `<port>`. |
| `sudo kill -9 <pid>` | Kill the process with with id `<pid>` |
| `pre-commit run --all-files` | Run the Linter & Formatter |

## [Poetry Commands](https://python-poetry.org/docs/basic-usage/)

Expand All @@ -19,6 +18,7 @@ When developing, these commands may come in handy:
| `poetry add <package-name>` | Add a new dependency to Poetry |
| `poetry add --group dev <package-name>` | Add a new developer dependency to Poetry |
| `poetry show` | List all available dependencies with descriptions |
| `poetry run pre-commit run --all-files` | Run the Linter & Formatter |

## [Mkdocs Commands](https://www.mkdocs.org/user-guide/)

Expand Down
2 changes: 1 addition & 1 deletion docs/styling.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ This is achieved using the ruff Linter and Formatter.

The Linter and Formatter are automatically executed before committing via pre-commit.

If you want to run the Linter and Formatter at any time, execute `pre-commit run --all-files`.
If you want to run the Linter and Formatter at any time, execute `poetry run pre-commit run --all-files`.

1 comment on commit 2eecd04

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

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

Coverage

Coverage Report
FileStmtsMissCoverMissing
src
   __init__.py00100% 
   api.py101694%30, 48, 70–71, 103–104
   art.py9367%24–25, 37
   cli.py23483%34, 50–51, 55
   gpt.py10640%16–21, 32–45
   helper.py1555863%53, 55, 57, 59, 61, 63, 65, 67, 69, 71, 73, 75, 77, 79, 91, 102–106, 132, 134, 136, 145–153, 165, 178–179, 197–199, 209, 211–212, 234–235, 272–282, 289–297
   send_email.py24240%5–48
   server.py41410%5–82
   settings.py220100% 
TOTAL38514263% 

Tests Skipped Failures Errors Time
9 0 💤 0 ❌ 0 🔥 15.512s ⏱️

Please sign in to comment.