Skip to content

Add compas_rhino.objects to API docs TOC#1517

Open
Copilot wants to merge 2 commits intoCOMPAS-2.x.LTSfrom
copilot/add-compas-rhino-objects-to-docs
Open

Add compas_rhino.objects to API docs TOC#1517
Copilot wants to merge 2 commits intoCOMPAS-2.x.LTSfrom
copilot/add-compas-rhino-objects-to-docs

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 10, 2026

compas_rhino.objects module was entirely absent from the generated API reference docs.

Changes

  • docs/api/compas_rhino.objects.rst — New RST file documenting all public functions in compas_rhino.objects (select/get/delete object helpers) via autosummary.
  • docs/api/index.rst — Added compas_rhino.objects entry to the compas_rhino toctree, between compas_rhino.geometry and compas_rhino.scene.

What type of change is this?

  • Bug fix in a backwards-compatible manner.
  • New feature in a backwards-compatible manner.
  • Breaking change: bug fix or new feature that involve incompatible API changes.
  • Other (e.g. doc update, configuration, etc)

Checklist

  • I added a line to the CHANGELOG.md file in the Unreleased section under the most fitting heading (e.g. Added, Changed, Removed).
  • I ran all tests on my computer and it's all green (i.e. invoke test).
  • I ran lint on my computer and there are no errors (i.e. invoke lint).
  • I added new functions/classes and made them available on a second-level import, e.g. compas.datastructures.Mesh.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added necessary documentation (if appropriate)

Agent-Logs-Url: https://github.com/compas-dev/compas/sessions/a9cbcd41-643c-486c-be1e-9ce5cbc645da

Co-authored-by: gonzalocasas <933277+gonzalocasas@users.noreply.github.com>
Copilot AI changed the title [WIP] Add compas_rhino.objects to generated documentation Add compas_rhino.objects to API docs TOC Apr 10, 2026
Copilot AI requested a review from gonzalocasas April 10, 2026 05:44
@gonzalocasas gonzalocasas marked this pull request as ready for review April 10, 2026 05:47
@gonzalocasas gonzalocasas requested a review from tomvanmele April 10, 2026 05:47
@gonzalocasas
Copy link
Copy Markdown
Member

@tomvanmele agree with this? was there a reason why compas_rhino.objects was removed from the API docs?

@codecov
Copy link
Copy Markdown

codecov bot commented Apr 10, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 62.35%. Comparing base (e61e29a) to head (f4a689c).

Additional details and impacted files
@@                Coverage Diff                 @@
##           COMPAS-2.x.LTS    #1517      +/-   ##
==================================================
- Coverage           62.37%   62.35%   -0.03%     
==================================================
  Files                 208      208              
  Lines               22502    22502              
==================================================
- Hits                14036    14031       -5     
- Misses               8466     8471       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

compas_rhino.objects entirely missing from the docs

2 participants