Conversation
Summary of ChangesHello @Laverne-Encord, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the clarity and consistency of the SDK's documentation by standardizing spelling conventions and improving the formatting of code examples within docstrings. These changes aim to make the documentation more professional and easier to read for all users. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
Unit test report (Python 3.9.24, Pydantic 2.12.3)267 tests 267 ✅ 9s ⏱️ Results for commit cea52bd. |
Unit test report (Python 3.9.24, Pydantic 1.10.22)267 tests 267 ✅ 9s ⏱️ Results for commit cea52bd. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request primarily focuses on improving the SDK's docstrings. It corrects several spelling mistakes from UK to US English for consistency, fixes a typo, and migrates code block formatting in docstrings from reStructuredText to Markdown. The changes are generally good and improve documentation quality. I've added a few suggestions to remove leftover reStructuredText syntax (::) for better Markdown rendering and consistency.
| form:: | ||
|
|
||
| ``` |
There was a problem hiding this comment.
While migrating the docstrings to use Markdown code blocks, the reStructuredText directive :: was left behind. This will be rendered as literal double colons in Markdown. It should be a single colon : for correct grammar and formatting.
| form:: | |
| ``` | |
| form: | |
| ``` |
| A labels dictionary for video is in the form:: | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Similar to a previous comment, the reStructuredText directive :: should be replaced with a single colon : now that the docstring is using Markdown for code blocks.
| A labels dictionary for video is in the form:: | |
| ``` | |
| A labels dictionary for video is in the form: | |
| ``` |
| A labels dictionary for an img_group data unit is in the form:: | ||
|
|
||
| ``` |
There was a problem hiding this comment.
The reStructuredText directive :: should be replaced with a single colon : for consistency with the move to Markdown for code blocks.
| A labels dictionary for an img_group data unit is in the form:: | |
| ``` | |
| A labels dictionary for an img_group data unit is in the form: | |
| ``` |
| The object answers dictionary is in the form:: | ||
|
|
||
| ``` |
There was a problem hiding this comment.
The reStructuredText directive :: should be replaced with a single colon : for consistency with the move to Markdown for code blocks.
| The object answers dictionary is in the form:: | |
| ``` | |
| The object answers dictionary is in the form: | |
| ``` |
| The classification answers dictionary is in the form:: | ||
|
|
||
| ``` |
There was a problem hiding this comment.
The reStructuredText directive :: should be replaced with a single colon : for consistency with the move to Markdown for code blocks.
| The classification answers dictionary is in the form:: | |
| ``` | |
| The classification answers dictionary is in the form: | |
| ``` |
| The object actions dictionary is in the form:: | ||
|
|
||
| ``` |
There was a problem hiding this comment.
The reStructuredText directive :: should be replaced with a single colon : for consistency with the move to Markdown for code blocks.
| The object actions dictionary is in the form:: | |
| ``` | |
| The object actions dictionary is in the form: | |
| ``` |
| * datasets:: | ||
|
|
||
| ``` |
There was a problem hiding this comment.
While migrating the docstrings to use Markdown code blocks, the reStructuredText directive :: was left behind. This will be rendered as literal double colons in Markdown. It should be a single colon : for correct grammar and formatting.
| * datasets:: | |
| ``` | |
| * datasets: | |
| ``` |
| * label_rows:: | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Similar to a previous comment, the reStructuredText directive :: should be replaced with a single colon : now that the docstring is using Markdown for code blocks.
| * label_rows:: | |
| ``` | |
| * label_rows: | |
| ``` |
SDK integration test report285 tests ±0 280 ✅ - 1 17m 38s ⏱️ - 2m 38s For more details on these failures, see this check. Results for commit cea52bd. ± Comparison against base commit af45b08. |
1 participant
Updates SDK Ref doc strings