diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/contributing/code.md | 23 | ||||
| -rw-r--r-- | docs/source/devguide/tutorials/01-setup.md | 2 | ||||
| -rw-r--r-- | docs/source/intro/01-install.md | 2 |
3 files changed, 13 insertions, 14 deletions
diff --git a/docs/source/contributing/code.md b/docs/source/contributing/code.md index 20ccb82..f2e78ee 100644 --- a/docs/source/contributing/code.md +++ b/docs/source/contributing/code.md @@ -51,18 +51,19 @@ time. They are both run with [pre-commit]. We follow [PEP8](http://www.python.org/dev/peps/pep-0008/) and [Python Code Style](http://docs.python-guide.org/en/latest/writing/style/) -which is adhered to with [Black]. +which is adhered to with [ruff]. -- Code '''must''' pass [Black], [flake8] and [isort] source code checkers. - (Optionally [Pylint]) +- Code **must** pass [ruff] linting and formatting with [pre-commit]: - flake8 deluge - isort -rc -df deluge - pylint deluge - pylint deluge/plugins/\*/deluge/ + pre-commit run --all-files -- Using the [pre-commit] application can aid in identifying issues while - creating git commits. +- Optionally [Pylint]: + + pylint deluge + pylint deluge/plugins/\*/deluge/ + +- Installing the [pre-commit] application can aid in identifying issues + while creating git commits. #### Strings and bytes @@ -116,9 +117,7 @@ Verify that the documentation parses correctly with: python setup.py build_docs [pre-commit]: http://pre-commit.com/ -[flake8]: https://pypi.python.org/pypi/flake8 -[isort]: https://pypi.python.org/pypi/isort +[ruff]: https://docs.astral.sh/ruff/ [pylint]: http://www.pylint.org/ -[black]: https://github.com/python/black/ [gtk3 unicode]: http://python-gtk-3-tutorial.readthedocs.org/en/latest/unicode.html [napoleon sections]: http://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#docstring-sections diff --git a/docs/source/devguide/tutorials/01-setup.md b/docs/source/devguide/tutorials/01-setup.md index 02195b1..0e3aa04 100644 --- a/docs/source/devguide/tutorials/01-setup.md +++ b/docs/source/devguide/tutorials/01-setup.md @@ -24,7 +24,7 @@ You might need to add `~/.local/bin` to your PATH. #### Runtime libraries and tools sudo apt install python3-libtorrent python3-geoip python3-dbus python3-gi \ - python3-gi-cairo gir1.2-gtk-3.0 gir1.2-appindicator3 python3-pygame libnotify4 \ + python3-gi-cairo gir1.2-gtk-3.0 gir1.2-ayatanaappindicator3-0.1 python3-pygame libnotify4 \ librsvg2-common xdg-utils ## Setup development environment diff --git a/docs/source/intro/01-install.md b/docs/source/intro/01-install.md index 15e9945..e103a6e 100644 --- a/docs/source/intro/01-install.md +++ b/docs/source/intro/01-install.md @@ -80,7 +80,7 @@ Will require system installed packages such as libtorent and GTK3. See [DEPENDS] e.g. on Ubuntu/Debian install these packages: - sudo apt install python3-pip python3-libtorrent python3-gi python3-gi-cairo gir1.2-gtk-3.0 gir1.2-appindicator3 + sudo apt install python3-pip python3-libtorrent python3-gi python3-gi-cairo gir1.2-gtk-3.0 gir1.2-ayatanaappindicator3-0.1 ## Alternative Installs |