Midnighter / structurizr-python

A Python 3 port of Simon Brown's Structurizr diagrams-as-code architecture description tool.
https://structurizr.com/
Apache License 2.0
65 stars 16 forks source link

Clean up flake8 warnings #46

Closed yt-ms closed 3 years ago

yt-ms commented 3 years ago

Problem description

Running flake8 against the project throws around 100 warnings currently. These should be tidied up so we can enable flake8 as part of the build.

Code Sample

src\structurizr\view\system_context_view.py:65:1: D102 Missing docstring in public method
src\structurizr\view\system_context_view.py:75:1: D102 Missing docstring in public method
src\structurizr\view\system_landscape_view.py:77:1: D102 Missing docstring in public method
src\structurizr\view\terminology.py:31:1: D414 Section has no content
etc.

Context

``` System Information ================== OS Windows OS-release 10 Python 3.7.5 Package Versions ================ depinfo 1.5.4 httpx 0.16.1 importlib_metadata 1.7.0 ordered-set 3.1 pip 20.2.4 pydantic 1.7.1 python-dotenv 0.14.0 setuptools 41.2.0 structurizr-python 0.1.1+32.g8fa91ab.dirty ```