You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/contributing.rst
+2-6Lines changed: 2 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -549,11 +549,7 @@ Code Formatting
549
549
550
550
xarray uses several tools to ensure a consistent code format throughout the project:
551
551
552
-
- `Black <https://black.readthedocs.io/en/stable/>`_ for standardized
553
-
code formatting,
554
-
- `blackdoc <https://blackdoc.readthedocs.io/en/stable/>`_ for
555
-
standardized code formatting in documentation,
556
-
- `ruff <https://github.com/charliermarsh/ruff/>`_ for code quality checks and standardized order in imports
552
+
- `ruff <https://github.com/charliermarsh/ruff/>`_ for formatting, code quality checks and standardized order in imports
557
553
- `absolufy-imports <https://github.com/MarcoGorelli/absolufy-imports>`_ for absolute instead of relative imports from different files,
558
554
- `mypy <http://mypy-lang.org/>`_ for static type checking on `type hints
- Test the code using `Pytest <http://doc.pytest.org/en/latest/>`_. Running all tests (type ``pytest`` in the root directory) takes a while, so feel free to only run the tests you think are needed based on your PR (example: ``pytest xarray/tests/test_dataarray.py``). CI will catch any failing tests.
1070
1066
- By default, the upstream dev CI is disabled on pull request and push events. You can override this behavior per commit by adding a ``[test-upstream]`` tag to the first line of the commit message. For documentation-only commits, you can skip the CI per commit by adding a ``[skip-ci]`` tag to the first line of the commit message.
1071
1067
1072
-
-**Properly format your code** and verify that it passes the formatting guidelines set by `Black<https://black.readthedocs.io/en/stable/>`_ and `Flake8<http://flake8.pycqa.org/en/latest/>`_. See `"Code formatting" <https://docs.xarray.dev/en/stablcontributing.html#code-formatting>`_. You can use `pre-commit <https://pre-commit.com/>`_ to run these automatically on each commit.
1068
+
-**Properly format your code** and verify that it passes the formatting guidelines set by `ruff<https://github.com/astral-sh/ruff>`_. See `"Code formatting" <https://docs.xarray.dev/en/stablcontributing.html#code-formatting>`_. You can use `pre-commit <https://pre-commit.com/>`_ to run these automatically on each commit.
1073
1069
1074
1070
- Run ``pre-commit run --all-files`` in the root directory. This may modify some files. Confirm and commit any formatting changes.
0 commit comments