Skip to content

Link API page for Annotation in nav structure#1452

Merged
normanrz merged 2 commits intomasterfrom
docs-annotation
Apr 9, 2026
Merged

Link API page for Annotation in nav structure#1452
normanrz merged 2 commits intomasterfrom
docs-annotation

Conversation

@hotzenklotz
Copy link
Copy Markdown
Member

@hotzenklotz hotzenklotz commented Apr 9, 2026

Description:

  • Extend the docs to link API page for Annotation in nav structure. Seem like a pretty serious omission.
Screenshot 2026-04-09 at 20 45 26

Todos:

Make sure to delete unnecessary points or to check all before merging:

  • Updated Changelog
  • Updated Documentation
  • Added / Updated Tests
  • Considered adding this to the Examples

@hotzenklotz hotzenklotz self-assigned this Apr 9, 2026
@hotzenklotz hotzenklotz requested a review from normanrz April 9, 2026 18:45
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation navigation in mkdocs.yml to include new sections for Annotation and AnnotationInfo. I recommend renaming the 'Annotations' header to 'Annotation' to maintain consistency with the singular naming convention used for other sections like 'Skeleton' and 'Dataset'.

docs/mkdocs.yml Outdated
- DataFormat: api/webknossos/dataset_properties/data_format.md
- LengthUnit: api/webknossos/dataset_properties/length_unit.md
- LayerToLink: api/webknossos/dataset/layer/layer_to_link.md
- Annotations:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For consistency with other sections in the API Reference (such as Dataset, Skeleton, and Geometry), this section header should be singular.

      - Annotation:

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 9, 2026

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines Covered Coverage Threshold Status
11315 9530 84% 80% 🟢

New Files

No new covered files...

Modified Files

No covered modified files...

updated for commit: fee1941 by action🐍

@normanrz
Copy link
Copy Markdown
Member

normanrz commented Apr 9, 2026

I wonder if we should switch to a mechanism where all public classes are automatically in the docs. Instead of listing them manually.

@normanrz normanrz merged commit 7014e2e into master Apr 9, 2026
23 checks passed
@normanrz normanrz deleted the docs-annotation branch April 9, 2026 19:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants