Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Docs] Update documentation and review docstrings (#5400)
# Description <!-- Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change. --> - Deleted parameter explanations from a how-to guide for maintenance and updated the code snippets. Added note referring to API reference. - Reviewed default mkdocstrings options in mkdocs.yml for maintenance as most files used the same options. Removed extra options from API reference. Docstrings style chosen as google, because most of them was using it. - Reviewed docstrings: coherence across classes and methods, typos, duplicated or missing information. Used ```python instead of >>>, so the example code snippets can be directly run when copied. - In questions, I also reviewed the type hinting for labels and the error message. Closes #5373 **Type of change** <!-- Please delete options that are not relevant. Remember to title the PR according to the type of change --> - Documentation update **How Has This Been Tested** <!-- Please add some reference about how your feature has been tested. --> **Checklist** <!-- Please go over the list and make sure you've taken everything into account -->
- Loading branch information