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] Update documentation and review docstrings #5400

Merged

Conversation

sdiazlor
Copy link
Contributor

@sdiazlor sdiazlor commented Aug 9, 2024

Description

  • 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

  • Documentation update

How Has This Been Tested

Checklist

@sdiazlor sdiazlor marked this pull request as draft August 9, 2024 10:16
@sdiazlor sdiazlor changed the title Docs/5373 update documentation and review docstrings [Docs] Update documentation and review docstrings Aug 9, 2024
@sdiazlor sdiazlor marked this pull request as ready for review August 9, 2024 10:28
Copy link

github-actions bot commented Aug 9, 2024

Docs for this PR have been deployed hidden from versioning: https://docs.argilla.io/docs_5373-update-documentation-and-review-docstrings

@sdiazlor
Copy link
Contributor Author

sdiazlor commented Aug 9, 2024

I still didn't apply the below changes, but discovered these options of the mkdocstrings module with the tags. I believe they can help the developers when searching in the API reference. WDYT? cc @davidberenstein1957 @burtenshaw
Screenshot 2024-08-09 at 12 04 20

@davidberenstein1957
Copy link
Member

@sdiazlor please add the tags, they are really helpful

@sdiazlor sdiazlor merged commit a6fc011 into releases/2.0.1 Aug 12, 2024
8 checks passed
@sdiazlor sdiazlor deleted the docs/5373-update-documentation-and-review-docstrings branch August 12, 2024 08:19
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.

2 participants