Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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...).