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

doc: add missing docstrings #82

Open
woile opened this issue Sep 12, 2022 · 3 comments
Open

doc: add missing docstrings #82

woile opened this issue Sep 12, 2022 · 3 comments

Comments

@woile
Copy link
Contributor

woile commented Sep 12, 2022

I'm working in adding some missing documentation to:

  • Container
  • SolvedDependant
  • Dependant
  • Dependant
  • Marker
  • AsyncExecutor

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
Copy link
Owner

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

@woile
Copy link
Contributor Author

woile commented Sep 15, 2022

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

@adriangb
Copy link
Owner

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants