docs(accordion): enhance inline documentation#2737
Open
bennypowers wants to merge 2 commits intomainfrom
Open
Conversation
|
✅ Deploy Preview for red-hat-design-system ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
Size Change: +882 B (+0.34%) Total Size: 258 kB
ℹ️ View Unchanged
|
- Enhanced `accents` property JSDoc with semantic meaning explaining inline vs bottom positioning and usage guidelines - Enhanced default slot documentation in rh-accordion-header with detailed description of title text best practices - Added comprehensive JSDoc for `expanded` property explaining when and why to use it - Added inline comment for `container` part describing its semantic role This addresses the missing documentation identified in issue #2487. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Assisted-By: Claude <noreply@anthropic.com>
bennypowers
force-pushed
the
docs/accordion-inline-docs
branch
from
d013c1f to
a7d3ea2
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What I did
Enhanced inline documentation for
rh-accordioncomponents to improve developer experience and API understanding, similar to the improvements made in PR #2548 forrh-progress-stepper.Testing Instructions
This documentation was created with assistance from LLM tools. Reviewers MUST carefully verify the semantic meaning and design system accuracy of all new documentation.
Please check that the enhanced documentation:
Specific sections to review:
1.
accentsproperty inrh-accordion.ts2. Default slot in
rh-accordion-header.ts3.
expandedproperty inrh-accordion-panel.ts4.
containerpart inrh-accordion-panel.tsNotes to Reviewers
hasChanged()method: This is not a public API method but an internal property configuration option forexpandedIndex, so it was not documented separately per the issue discussionrh-accordion-headeralready had a basic comment, which was enhanced with detailed usage guidelinesCloses #2487
🤖 Generated with Claude Code