style-doc
style-doc copied to clipboard
telekom
Black for Python docstrings and reStructuredText (rst).
Currently the search for `"""` isn't respecting commented out code: ```python # For future implementation # def base_url(self) -> str: # """ # Generate SCIM base url # """ #...
Have you considered packaging `style-doc` for use as a git pre-commit hook, and listing it with the [pre-commit](https://pre-commit.com/) project? It seems like it would be a great addition, and make...
The constructor should be documented at class level and not at the __init__ function.
We had to apply this workaround: https://github.com/telekom/style-doc/blob/db352ed72ae4473a805d485692df58ec4511a673/style_doc/style_doc.py#L495-L497 `# fmt: off` and `# fmt: on` is needed so black does not convert it back to `'"""'`.
Use `pyproject.toml` see black - https://github.com/psf/black/blob/7567cdf3b4f32d4fb12bd5ca0da838f7ff252cfc/src/black/files.py#L69 - https://github.com/psf/black/blob/017aafea992ca1c6d7af45d3013af7ddb7fda12a/src/black/__init__.py#L44