adriangb / di

Pythonic dependency injection
https://www.adriangb.com/di/
MIT License
301 stars 13 forks source link

doc: add missing docstrings #82

Open woile opened 2 years ago

woile commented 2 years ago

I'm working in adding some missing documentation to:

I was wondering if adding mkdocstrings would be welcomed as well. I think having an API Reference at the end of the docs would be useful. Thoughts?

adriangb commented 2 years ago

I've never been able to get mkdocstrings to work well. Let's start with some docstrings and we can add mkdocstrings later.

woile commented 2 years ago

Would you like me to give it a try at mkdocstrings? It's been working well for me.

adriangb commented 2 years ago

Sure worth a shot! It might even uncover some ugly part of the codebase that doesn't play well with it. Thank you for investing time into this.