Closed ppebay closed 1 year ago
This is a follow-on to PR #357 as some style/consistency issues were noted (but were not blocking for said PR):
- inconsistency in naming of utility classes (in
Utils
): they should start withlbs
- inconsistent use of final full stop before triple quotes in docstrings
- still some occurrences of exclamation marks in error/warning outputs
All of the above should be addressed as part of this issue
Ok Philippe. Regarding docstrings I would recommend what is described at https://realpython.com/documenting-python-code/
For single line docstrings :
"""This is the summary line""" (1 line, no space after or before """)
For multiline docstrings :
"""This is the summary line
This is the further elaboration of the docstring. Within this section,
you can elaborate further on details as appropriate for the situation.
"""
With an empty line after the summary of a class docstring
Alright, thanks for suggestion @tlamonthezie so please apply changes above throughout entire code base thanks.
Any update on that one @tlamonthezie ?
Any update on that one @tlamonthezie ?
Hello @ppebay not for the moment but soon
This is a follow-on to PR #357 as some style/consistency issues were noted (but were not blocking for said PR):
Utils
): they should start withlbs
, with the exception of:All of the above should be addressed as part of this issue
Reference : https://peps.python.org/pep-0008/#package-and-module-names