slashme / parliamentdiagram

Parliament diagram creator
GNU General Public License v2.0
99 stars 27 forks source link

Cleanup docstrings and type annotations #120

Closed Gouvernathor closed 1 month ago

Gouvernathor commented 2 years ago

The current sizeable docstrings in the python file are not standardized and structured. Their autosimilarity interferes with changes readability, and the very size of it makes going from function to function harder. After the PRs are cleared, it would be good to clean that up, maybe implementing the types information for the arguments using python's integrated type annotations, with the types module. If not (type-checkers would not be enabled anyway), the info which is there now should be standardized, if only to make it smaller and more readable.