Here is an interesting reddit post that I made on /r/Python


I just finished a Python project and now want to go back and document each function while it is still fresh in my head. Is there a program that will scan your code for functions that don’t have a doc-string and then interactively ask you to:

  • describe the function
  • document each parameter
  • document the return value

It would then create a doc-string for you that you could simply copy/paste into your code.


The solution that I ended up going with was this Visual Studio Code extension: Python Docstring Generator. This is exactly what I was looking for and it works very well!