Skip to content
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

Switch @api private to official JSDoc #2018

Merged
merged 1 commit into from
Sep 16, 2023

Conversation

shadowspawn
Copy link
Collaborator

Pull Request

Problem

Commander uses @api private which didn't make it into official JSDoc, although supported in some implementations.

See: #1949

Solution

Switch to @private, or @package for routines that are intended for internal use (or happen to be used internally!).

Made .attributeName() public in the JSDoc to match the TypeScript, which is the intended visibility as needed to look up option values.

(I targeted v12 in case breaks some client use in an environment which actually starts warning about use of private routines.)

Copy link
Collaborator

@abetomo abetomo left a comment

Choose a reason for hiding this comment

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

+1

@shadowspawn shadowspawn merged commit 37c9398 into tj:release/12.x Sep 16, 2023
9 checks passed
@shadowspawn shadowspawn deleted the feature/jsdoc-private branch September 16, 2023 04:39
@shadowspawn shadowspawn added the pending release Merged into a branch for a future release, but not released yet label Sep 16, 2023
@shadowspawn shadowspawn removed the pending release Merged into a branch for a future release, but not released yet label Feb 3, 2024
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