Things on this page are fragmentary and immature notes/thoughts of the author. Please read with your own judgement!

1. The extension Python Docstring Generator is recommended.

2. The Sphinx docstring style is recommended.

References

https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring

https://github.com/NilsJPWerner/autoDocstring

Things on this page are fragmentary and immature notes/thoughts of the author. Please read with your own judgement!

Tips and Traps

1. It is suggested that you avoid using darglint directly, but instead you can use flake8 which will automatically call darglint if it exists.

2. Improperly escaped \n causes darglint …