Fix minor typos in Contributing guidelines

This commit is contained in:
Curtis Gedak
2020-12-19 13:48:03 -07:00
parent 0e8cb1059f
commit 4e90f82af3
+3 -3
View File
@@ -50,14 +50,14 @@ The command line equivalent, with reporting, is:
flake8 . --count --ignore E203,E221,E226,E241,E251,E261,E266,E302,E305 --max-line-length=99 --show-source --statistics flake8 . --count --ignore E203,E221,E226,E241,E251,E261,E266,E302,E305 --max-line-length=99 --show-source --statistics
``` ```
Passing this check is required before contributuions are merged into the `main` branch. This is Passing this check is required before contributions are merged into the `main` branch. This is
checked automatically when you make a pull request. You can run the `flake8` command locally to checked automatically when you make a pull request. You can run the `flake8` command locally to
check beforehand. The full command will give you a detailed description of the code lines that do check beforehand. The full command will give you a detailed description of the code lines that do
not conform to the standard. not conform to the standard.
## Ignored Errors ## Ignored Errors
Some errors are ignored in novelWriter, for various reasons. In addition, novelWriter sues camelCase Some errors are ignored in novelWriter, for various reasons. In addition, novelWriter uses camelCase
function and variable names due to this being the standard for the Qt libraries, and also because of function and variable names due to this being the standard for the Qt libraries, and also because of
the author's personal preferences. the author's personal preferences.
@@ -99,5 +99,5 @@ like markdown headers.
make it easier to see which class just ended. The double line break is then redundant. make it easier to see which class just ended. The double line break is then redundant.
**E305:** expected 2 blank lines after end of function or class **E305:** expected 2 blank lines after end of function or class
**Reason:** Instead, _always_ end a function with a `return`, preferrably indented at function **Reason:** Instead, _always_ end a function with a `return`, preferably indented at function
level. The end of the function is then clear. level. The end of the function is then clear.