Added Comments and explanation to functions

mcdallas / wallstreet

Real time stock and option data.

MIT License

1.33k stars 201 forks source link

Added Comments and explanation to functions #52

Open arshkumarsingh opened 3 months ago

arshkumarsingh commented 3 months ago

Added some comments and docstrings I thought were useful and would help in this program's maintainability in the future

mcdallas commented 3 months ago

Hey @arshkumarsingh, thanks for the contribution. The library is indeed poorly documented but adding an LLM created comment above every line of code is the opposite extreme. I don’t think that

helps anyone, it just adds bloat. Maybe we could just add the docstrings and get rid of the comments

arshkumarsingh commented 3 months ago

Thanks for the reply and advice, intention was not to bloat but will fix it and revert 👍