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

Make docstring style consistent #49

Open
alexdewar opened this issue Oct 2, 2024 · 0 comments
Open

Make docstring style consistent #49

alexdewar opened this issue Oct 2, 2024 · 0 comments

Comments

@alexdewar
Copy link
Collaborator

PR #45 adds support for auto-building and publishing API documentation using mkdocs.

Currently the docstrings appear to be in a mixture of Google and sphinx styles. While both are supported by the mkdocstrings-python backend (see here), you need to tell mkdocs which style you're using in order for the documentation to render correctly. (To check where there are issues, you can build the docs with mkdocs build and the underlying griffe library will give warnings about malformed docstrings.)

Both styles are fine, so just pick one and run with it. ruff supports enforcing a docstring style, so longer term this would be a good idea.

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

No branches or pull requests

1 participant