From 7d56a58f1bf5d71fa7b60b846b3ef05905930ad2 Mon Sep 17 00:00:00 2001 From: "Andrew S. Rosen" Date: Mon, 18 Nov 2024 11:06:55 -0500 Subject: [PATCH] Update source.md --- docs/example_docs/code/source.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/example_docs/code/source.md b/docs/example_docs/code/source.md index 7e6f2a2..8c698b8 100644 --- a/docs/example_docs/code/source.md +++ b/docs/example_docs/code/source.md @@ -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.