Chore: Fixed links

[david-babuschkin-encord]

Introduction and Explanation

Some introductory context and overview

JIRA

Link ticket(s)

Documentation

There should be enough internal documentation for a product owner to write customer-facing documentation or a separate PR linked if writing the customer documentation directly. Link all that are relevant below.

• Internal: notion link
• Customer docs PR: link
• OpenAPI/SDK
  • Generated docs: link to example if possible
  • Command to generate: here

Tests

Make a quick statement and post any relevant links of CI / test results. If the testing infrastructure isn’t yet in-place, note that instead.

• What are the critical unit tests?
• Explain the Integration Tests such that it’s clear Correctness is satisfied. Link to test results if possible.

Known issues

If there are any known issues with the solution, make a statement about what they are and why they are Ok to leave unsolved for now. Make tickets for the known issues linked to the original ticket linked above

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! 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 primarily focuses on enhancing the clarity and accuracy of the project's documentation. It addresses issues with broken internal links within docstrings and comments, ensuring that all cross-references correctly point to their intended targets. Additionally, it improves the discoverability and understanding of core enumeration types by adding comprehensive docstrings, making the codebase easier to navigate and comprehend for developers and users alike.

Highlights

• Documentation Link Fixes: Corrected numerous broken reStructuredText cross-references (:class:, :meth:, :func:) across the codebase to point to the correct, fully qualified paths of classes and methods, improving documentation accuracy.
• Enum Docstring Enhancements: Added detailed docstrings to key enumeration classes (DataType, PropertyType, Shape) to provide clearer explanations of their purpose and available values.
• Deprecated Class Reference Updates: Updated references to deprecated ontology classes (OntologyClassification, OntologyObject) to reflect the recommended usage of encord.ontology.Ontology.

Changelog

• docs/source/code_examples/labels_v2.py
  • Updated :class: and :meth: references for LabelRowV2 and OntologyStructure to their fully qualified paths.
• encord/client.py
  • Corrected :class: references for LabelRowV2 in docstrings for save_label_rows, create_label_rows, workflow_reopen, and workflow_complete methods.
• encord/constants/enums.py
  • Added a detailed docstring for the DataType enum, explaining its purpose and listing its values.
• encord/http/utils.py
  • Updated the reStructuredText link format for itertools.batched in the get_batches function's docstring.
• encord/objects/classification_instance.py
  • Corrected :class: references for RadioAttribute, ChecklistAttribute, and TextAttribute in the set_answer method's docstring.
• encord/objects/common.py
  • Added detailed docstrings for the PropertyType and Shape enums, explaining their purposes and listing their values.
• encord/orm/dataset.py
  • Updated :class: and :meth: references for DataRow, ImageData, and DataType in various docstrings.
• encord/project.py
  • Corrected :class: references for AnnotationTaskStatus, ShadowDataState, and LabelRowV2 in the list_label_rows_v2 method's docstring.
• encord/project_ontology/ontology_classification.py
  • Updated the deprecated class reference for Ontology in the OntologyClassification docstring.
• encord/project_ontology/ontology_object.py
  • Updated the deprecated class reference for Ontology in the OntologyObject docstring.
• encord/storage.py
  • Corrected :class: references for Bundle in the update methods of Folder and Item classes.
• encord/user_client.py
  • Updated :class: references for Project and ManualReviewWorkflowSettings in docstrings for list_projects and create_project methods.

Activity

• No specific human activity (comments, reviews, progress updates) has been recorded for this pull request yet.

Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[github-actions]

Unit test report (Python 3.9.24, Pydantic 1.10.22)

513 tests   513 ✅  11s ⏱️
  1 suites    0 💤
  1 files      0 ❌

Results for commit c5d6d9a.

♻️ This comment has been updated with latest results.

[github-actions]

Unit test report (Python 3.9.24, Pydantic 2.12.3)

513 tests   513 ✅  13s ⏱️
  1 suites    0 💤
  1 files      0 ❌

Results for commit c5d6d9a.

♻️ This comment has been updated with latest results.

[gemini-code-assist]

Warning

Gemini is experiencing higher than usual traffic and was unable to create the review. Please try again in a few hours by commenting /gemini review.

[github-actions]

SDK integration test report

  1 files  ±0    1 suites  ±0   21m 51s ⏱️ -38s
289 tests ±0  277 ✅  - 2  4 💤 ±0  7 ❌ +2  1 🔥 ±0 
290 runs  ±0  277 ✅  - 2  4 💤 ±0  7 ❌ +2  2 🔥 ±0 

For more details on these failures and errors, see this check.

Results for commit c5d6d9a. ± Comparison against base commit 552a77d.