-
Notifications
You must be signed in to change notification settings - Fork 3
chore(tags): updated API documentation #1035
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates API documentation for the tag list component by adding proper JSDoc annotations and improving type safety.
- Replaces string literal type with
KbqOrientation
enum for the orientation property - Adds comprehensive
@docs-private
annotations to internal methods and properties - Removes undocumented markers from the public API guard file
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
File | Description |
---|---|
tools/public_api_guard/components/tags.api.md | Updates API documentation to reflect type changes and remove undocumented markers |
packages/components/tags/tag-list.component.ts | Adds JSDoc annotations and replaces string literal orientation type with KbqOrientation enum |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Visit the preview URL for this PR (updated for commit ee3151d): https://koobiq-next--prs-1035-vhfaetva.web.app (expires Wed, 01 Oct 2025 12:42:23 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: c9e37e518febda70d0317d07e8ceb35ac43c534c |
/** | ||
* Implemented as part of ControlValueAccessor. | ||
* | ||
* @docs-private |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
можно не помечать т.к. оно итак фильтруется, аналогично для остальных
'writeValue', |
OnDestroy, | ||
CanUpdateErrorState | ||
{ | ||
/** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
а почему не в одну строку ?
No description provided.