diff --git a/Contributing.md b/Contributing.md index ff683dff..4b7bdaae 100644 --- a/Contributing.md +++ b/Contributing.md @@ -181,44 +181,43 @@ Coding Conventions * **ALWAYS** place a single-statement control flow body, for control statements such as `if`, `else`, `for`, `foreach`, on a separate line, with consistent indentation. -Yes: + Yes: -```python -if somethingTrue: - Things_we_then_do() -``` + ```python + if somethingTrue: + Things_we_then_do() + ``` -No: + No: -```python -if somethingTrue: One_thing_we_do() -``` + ```python + if somethingTrue: One_thing_we_do() + ``` Yes, some existing code still flouts this rule. * **Always** use Line breaks after scope changes. It makes reading code far easier -Yes: + Yes: -```python - if True: - do_something() + ```python + if True: + do_something() - else: - raise UniverseBrokenException() + else: + raise UniverseBrokenException() - return -``` + return + ``` + No: -No: - -```python - if True: - do_something() - else: - raise UniverseBrokenException() - return -``` + ```python + if True: + do_something() + else: + raise UniverseBrokenException() + return + ``` * Going forwards please do place [type hints](https://docs.python.org/3/library/typing.html) on the declarations of your functions, both their arguments and return diff --git a/docs/Releasing.md b/docs/Releasing.md index 26246803..3427dd50 100644 --- a/docs/Releasing.md +++ b/docs/Releasing.md @@ -55,12 +55,9 @@ You will need several pieces of software installed, or the files from their 1. Ensure you have `pip` installed. If needs be see [Installing pip](https://pip.pypa.io/en/stable/installing/) 1. The easiest way is to utilise the `requirements-dev.txt` file: - `python -m pip install -r requirements-dev.txt`. This will install all - dependencies plus anything required for development *other than py2exe, see - above*. - 1. Else check the contents of both `requirements.txt` and `requirements-dev.txt`, - and ensure the modules listed there are installed as per the version - requirements. + `python -m pip install -r requirements-dev.txt`. This will install all dependencies plus anything required for development + 1. Else check the contents of both `requirements.txt` and `requirements-dev.txt`, and ensure the modules + listed there are installed as per the version requirements. If you are using different versions of any of these tools then please ensure that the paths where they're installed match the associated lines in