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

docs: fix and update docstrings #1891

Closed
wants to merge 8 commits into from

Conversation

sanzoghenzo
Copy link
Contributor

As discussed with @jmcouffin on the forum, this PR updates and fixes some of the docstrings of the pyrevit package.

There are still many functions and methods without docstrings, and some docstring without the arguments and types description, but it's a start to have better documented code.

Some of the style choices (for example the return types between parenthesis) were a consequence of my desire to move to the more modern, markdown-centric, MkDocs documentation builder instead of sphinx, and some shortcomings found in mkdocstrings plugin, already discussed in the forum.

I added ruff to the root python 3.10 toolchain and enabled the documentation ("D") checks because of the vast performance gain over pylint; it could be used also for other checks and maybe for git pre-commit hooks and CI jobs in order to allow only clean code to be committed (but this is another story...).

@sanzoghenzo sanzoghenzo deleted the develop branch August 17, 2023 09:33
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

Successfully merging this pull request may close these issues.

1 participant