Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

No docstrings and comments in the code #2

Open
warvariuc opened this issue Jul 26, 2024 · 2 comments
Open

No docstrings and comments in the code #2

warvariuc opened this issue Jul 26, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation question Further information is requested

Comments

@warvariuc
Copy link

I consider dependency_injector over-engineered. It has many providers which look the same, but it's not clear which and when to use.
This version seems much cleaner, with less magic.

However, going through the code, I see almost no docstrings and comments. This means that one has to consult the docs (if there are docs) in hope to understand details about some providers, their arguments.

@nightblure nightblure added the question Further information is requested label Jul 26, 2024
@nightblure nightblure self-assigned this Jul 26, 2024
@nightblure
Copy link
Owner

nightblure commented Jul 26, 2024

@warvariuc
Hi!
Thank you for your request!

Today is the first day of the release of my package and I decided to do it a little prematurely, because the only thing that hasn’t been fully worked out is the documentation.

I think your comment is fair regarding overengineering in dependency_injector. But my package contains very little code and it works the same (except that some providers, in my opinion, are not very useful)

It seems that I have sufficiently covered the code with types and the most important thing - it is very simple! So, IMO it does not need docstrings and comments. And I’ll be actively working on documentation next week, I’ll start with a description of providers and use cases

However, I would choose having docstrings over not having them. I'd love it if you could help with this while I'm busy documenting it!

@nightblure
Copy link
Owner

@warvariuc
I will not close this issue until I complete the documentation. I hope after this my package deserves a star from you xd

@nightblure nightblure added the documentation Improvements or additions to documentation label Jul 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants