From 3365201011f9f23f48dcaf09d82eab8668c36c73 Mon Sep 17 00:00:00 2001 From: Calum Lind Date: Tue, 18 Jun 2019 00:01:26 +0100 Subject: [PATCH] [Docs] Fixes for spelling Running on Ubuntu Xenial results in spelling warnings so update wordlist. --- docs/source/contributing/code.md | 3 ++- docs/source/devguide/how-to/curl-jsonrpc.md | 4 ++-- docs/source/devguide/packaging/release.md | 2 +- docs/source/devguide/tutorials/01-setup.md | 4 ++-- docs/spelling_wordlist.txt | 14 ++++++++++++++ 5 files changed, 21 insertions(+), 6 deletions(-) diff --git a/docs/source/contributing/code.md b/docs/source/contributing/code.md index 1148d7646..20ccb820b 100644 --- a/docs/source/contributing/code.md +++ b/docs/source/contributing/code.md @@ -61,7 +61,8 @@ which is adhered to with [Black]. pylint deluge pylint deluge/plugins/\*/deluge/ -- Using the [pre-commit] app can aid in identifying issues while creating git commits. +- Using the [pre-commit] application can aid in identifying issues while + creating git commits. #### Strings and bytes diff --git a/docs/source/devguide/how-to/curl-jsonrpc.md b/docs/source/devguide/how-to/curl-jsonrpc.md index 0d39c5813..9bb559d6e 100644 --- a/docs/source/devguide/how-to/curl-jsonrpc.md +++ b/docs/source/devguide/how-to/curl-jsonrpc.md @@ -18,9 +18,9 @@ a `curl.cfg` files and put the following contents in it: To pretty-print the JSON result see: -## Login to Web UI +## Log in to Web UI -Login to the Web UI and get session cookie: +Log in to the Web UI and get session cookie: curl -d '{"method": "auth.login", "params": ["deluge"], "id": 1}' -K curl.cfg diff --git a/docs/source/devguide/packaging/release.md b/docs/source/devguide/packaging/release.md index 8fd9af5c7..892b5fcde 100644 --- a/docs/source/devguide/packaging/release.md +++ b/docs/source/devguide/packaging/release.md @@ -28,7 +28,7 @@ - Sub-directories correspond to _major.minor_ version e.g. all `2.0.x` patch releases are stored in `source/2.0`. - Change release version in `version` files. - - Run `trigger-deluge` to sync OSUOSL ftp site. + - Run `trigger-deluge` to sync OSUOSL FTP site. - Create packages (Ubuntu, Windows, OSX). - Ubuntu: diff --git a/docs/source/devguide/tutorials/01-setup.md b/docs/source/devguide/tutorials/01-setup.md index ec2f4f054..da634d588 100644 --- a/docs/source/devguide/tutorials/01-setup.md +++ b/docs/source/devguide/tutorials/01-setup.md @@ -37,7 +37,7 @@ Download the latest git code to local folder. ### Create Python virtual environment Creation of a [Python virtual environment] keeps the development isolated -and easier to maintain and tox has an option to make this process easier: +and easier to maintain and Tox has an option to make this process easier: tox -e denv3 @@ -45,7 +45,7 @@ Activate virtual environment: source .venv/bin/activate -Deluge will be installed by tox in _develop_ mode which creates links back +Deluge will be installed by Tox in _develop_ mode which creates links back to source code so that changes will be reflected immediately without repeated installation. Check it is installed with: diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index 0673c588e..9a841f7c0 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -26,3 +26,17 @@ auth hostlist hostname filesystem +libtorrent +Multi +multi +username +whitelist +systemd +launchd +plugin +plugins +app +tarball +tarballs +Umask +online