GeospatialResearch / Digital-Twins

https://geospatialresearch.github.io/Digital-Twins/
GNU Affero General Public License v3.0
14 stars 7 forks source link

Add additional more strict python linting rules for documentation #159

Closed LukeParky closed 4 weeks ago

LukeParky commented 1 month ago

Add additional auto linting rules to the github runner. Additional rules required include but are not limited to:

It is not recommended to change the format we are already using to write out docstrings, since this works for sphinx autodoc and would be a large task.

LukeParky commented 1 month ago

@caseyli92 I was wondering if you would like to do this task to get some practice with github actions

LukeParky commented 1 month ago

We currently use flake8 for this, but if it doesn't have the rules available for linting documentation you may have to use pylint

caseyli92 commented 4 weeks ago

Linked to PR #196, merged into otakaro_digital_twin branch.