Skip to content

Conversation

Copy link

Copilot AI commented Oct 8, 2025

Description

Updated the JSDoc comments for the expanded property getter and setter methods in src/RoleObjects/DialogData.js to be more detailed and descriptive. The comments now span two lines each, providing better clarity and understanding for developers.

Changes

set expanded method comment

Before:

/**
 * Sets whether the element should get expanded
 * @access public
 * @param {boolean} val - true if expanded, false if not expanded, undefined if the field is unset
 */

After:

/**
 * Sets whether the dialog element is expanded or collapsed.
 * When expanded, the dialog's content is visible to the user.
 * @access public
 * @param {boolean} val - true if expanded, false if not expanded, undefined if the field is unset
 */

get expanded method comment

Before:

/**
 * Retrieves whether expanded
 * @access public
 * @returns {boolean} true if expanded, false if not expanded, undefined if the field is unset
 */

After:

/**
 * Retrieves whether the dialog element is expanded or collapsed.
 * Checks the 'aria-expanded' property in the underlying React props.
 * @access public
 * @returns {boolean} true if expanded, false if not expanded, undefined if the field is unset
 */

Impact

  • No functional changes - Only documentation/comments were updated
  • Improved developer experience - Comments now provide more context about what the methods do
  • Consistent with codebase patterns - Follows the same style used in similar files like DocumentData.js and ComboBoxData.js

Testing

  • ✅ All existing tests pass
  • ✅ Linter checks pass
  • ✅ Code formatting validated with Prettier
Original prompt

The file src/RoleObjects/DialogData.js in the repository nmahesh-cainc/createjs-accessibility contains comments for the set and get methods of the expanded property. These comments should be updated to make them more detailed and elaborated into two lines for better clarity and understanding. The changes should not affect the functionality of the code, only the comments.

*This pull request was created as a result of the following prompt from Copilot chat.* > The file `src/RoleObjects/DialogData.js` in the repository `nmahesh-cainc/createjs-accessibility` contains comments for the `set` and `get` methods of the `expanded` property. These comments should be updated to make them more detailed and elaborated into two lines for better clarity and understanding. The changes should not affect the functionality of the code, only the comments.

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: nmahesh-cainc <233236058+nmahesh-cainc@users.noreply.github.com>
Copilot AI changed the title [WIP] Update comments for expanded property methods Enhance DialogData.js comments for expanded property getter and setter methods Oct 8, 2025
Copilot AI requested a review from nmahesh-cainc October 8, 2025 19:18
Copilot finished work on behalf of nmahesh-cainc October 8, 2025 19:18
@nmahesh-cainc
Copy link
Owner

Requesting admins to review this pull request. Please take a look and provide feedback when convenient. Thank you!

@nmahesh-cainc nmahesh-cainc marked this pull request as ready for review October 9, 2025 06:45
Copy link
Owner

@nmahesh-cainc nmahesh-cainc left a comment

Choose a reason for hiding this comment

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

yes the changes made match with the task assigned

@nmahesh-cainc nmahesh-cainc merged commit 6560d5b into main Oct 9, 2025
@nmahesh-cainc nmahesh-cainc deleted the copilot/update-dialogdata-comments branch October 9, 2025 07:43
@nmahesh-cainc nmahesh-cainc restored the copilot/update-dialogdata-comments branch October 9, 2025 07:53
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.

2 participants