Skip to content

Update API documentation for Annotations#24277

Open
sgiehl wants to merge 3 commits into5.x-devfrom
apidocs_annotations
Open

Update API documentation for Annotations#24277
sgiehl wants to merge 3 commits into5.x-devfrom
apidocs_annotations

Conversation

@sgiehl
Copy link
Copy Markdown
Member

@sgiehl sgiehl commented Mar 29, 2026

Description

Checklist

  • [✔] I have understood, reviewed, and tested all AI outputs before use
  • [✔] All AI instructions respect security, IP, and privacy rules

Review

@sgiehl sgiehl added c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base. c: APIs For bugs and features in the Matomo HTTP and plugin APIs. Technical debt Issues the will help to reduce technical debt labels Mar 29, 2026
@sgiehl sgiehl changed the base branch from apidocs to apidocs_aiagents March 29, 2026 15:05
@sgiehl sgiehl added this to the 5.9.0 milestone Mar 29, 2026
@sgiehl sgiehl force-pushed the apidocs_annotations branch from 9ea036d to 7073205 Compare March 29, 2026 15:11
@sgiehl sgiehl marked this pull request as ready for review March 29, 2026 16:32
@sgiehl sgiehl requested a review from a team March 29, 2026 16:32
Base automatically changed from apidocs_aiagents to 5.x-dev March 30, 2026 06:18
@sgiehl sgiehl force-pushed the apidocs_annotations branch from c68c477 to 09b2669 Compare March 30, 2026 06:20
@sgiehl sgiehl force-pushed the apidocs_annotations branch from 09b2669 to fcf33b3 Compare March 30, 2026 09:09
Copy link
Copy Markdown
Contributor

@nathangavin nathangavin left a comment

Choose a reason for hiding this comment

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

What is the reasoning behind removing the @throws tags?

/**
* @return array<int,array<string,string|int|bool>>
* @throws \Exception
* @return list<Annotation>
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.

Suggested change
* @return list<Annotation>
* @return array<Annotation>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

c: APIs For bugs and features in the Matomo HTTP and plugin APIs. c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base. Technical debt Issues the will help to reduce technical debt

Development

Successfully merging this pull request may close these issues.

2 participants