autoDocstring
autoDocstring copied to clipboard
NilsJPWerner
Added class and module docstrings
class docstrings are created under the class definition. They read parameters from the init() method and scan the entire class for attributes. Both parameters and attributes are listed.
module docstrings are created at the first line of the script. They scan the entire file and list out all top-level classes and methods defined therein.
All tests are passing, and I added a few unit tests and integration tests. I am not an expert at TypeScript, so this might can be improved, but I've been using this on my code for a few months now with no problems.
@tracetidwell thank you for contributing to this project. This feature would help out so many of us that have expressed interest in issue #27. It would be really helpful if you addressed the comments that the repo owner @NilsJPWerner has requested, then he can followup and get this merged and published for us all to use :)
After way, WAY too long, I am going to finish this. I resolved a number of issues, left comments on a couple others, and need to work on the rest. If this is not being maintained or doesn't seem worth it, please let me know.
I haven't touched this repo in years, but I think I still have the repo cloned locally. @tracetidwell let me know if you need something from me. would love to help get this completed and merged.
Bumping this again? Would love to see this merged? If not, does anyone know any alternatives?
If @tracetidwell or someone else wants to pick up the PR again or start fresh I would be happy to review and merge. Right now I am focused on adding the ability to update docstrings, and so work on module and class docstrings will have to come afterwards.
Really, sitting in this state for over two years? I don't think this is being maintained any longer.
Did anyone perhaps forked and added this feature? I would love to use it! It appears the repo's owner forsaken this project, as there were no pushes made in over a year.
