Add a couple of more code style guidelines.
All checks were successful
build / test (push) Successful in 5m55s
build / docs (push) Successful in 1m35s

This commit is contained in:
Dan Helfman 2024-07-07 20:49:27 -07:00
parent 1f82ea2798
commit 4313f90dd8

View File

@ -157,8 +157,12 @@ the following deviations from it:
* Import fully qualified Python modules instead of importing individual
functions, classes, or constants. E.g., do `import os.path` instead of
`from os import path`. (Some exceptions to this are made in tests.)
* Only use classes and OOP as a last resort, such as when integrating with
Python libraries that require it.
* Prefer functional code where it makes sense, e.g. when constructing a
command (to subsequently execute imperatively).
borgmatic code uses the [Black](https://black.readthedocs.io/en/stable/) code
borgmatic uses the [Black](https://black.readthedocs.io/en/stable/) code
formatter, the [Flake8](http://flake8.pycqa.org/en/latest/) code checker, and
the [isort](https://github.com/timothycrosley/isort) import orderer, so
certain code style requirements are enforced when running automated tests. See