Skip to content

Commit

Permalink
Update source.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrew-S-Rosen authored Nov 18, 2024
1 parent 632b780 commit 7d56a58
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/example_docs/code/source.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,7 @@ All the code in the `src` directory can be imported now that you have installed
## Docstrings

The code comments beneath each function are called docstrings. They should provide an overview of the purpose of the function, the various parameters, and the return values (if any). Here, we are using the [NumPy style](https://numpydoc.readthedocs.io/en/latest/format.html) docstrings, but you can pick a different style if you like later on.

## Linting and Formatting

When you installed the `[dev]` dependencies, you also installed [`ruff`](https://docs.astral.sh/ruff/), which is a versatile Python linter to clean up your code. To run `ruff`, use the following command in the base directory: `ruff check --fix`. This will also be done automatically on pull requests via the pre-commit CI tool.

0 comments on commit 7d56a58

Please sign in to comment.