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

Removal of @private and @internal comments make VSCode suggest private fields #4132

Closed
2 tasks done
romaricpascal opened this issue Aug 24, 2023 · 1 comment
Closed
2 tasks done
Labels
🐛 bug Something isn't working the way it should (including incorrect wording in documentation) javascript
Milestone

Comments

@romaricpascal
Copy link
Member

romaricpascal commented Aug 24, 2023

What

Discuss whether to ensure private and internal fields are not suggested by VSCode

Why

With the merge of the removal of comments, we removed @private and @internal JSDoc comments. This makes VSCode suggests private fields, like the SkipLink's $linkedElement in a project that consumes GOV.UK Frontend.

Who needs to work on this

Developers

Who needs to review this

Developers

Done when

  • We've discussed whether to ensure private and internal fields are not suggested by VSCode
  • We've created any issues (if at all) coming out of this discussion
@romaricpascal romaricpascal added 🐛 bug Something isn't working the way it should (including incorrect wording in documentation) javascript labels Aug 24, 2023
@romaricpascal romaricpascal added this to the v5.0 milestone Aug 24, 2023
@36degrees 36degrees moved this from Backlog 🗄 to To discuss in GOV.UK Design System cycle board Nov 6, 2023
@romaricpascal
Copy link
Member Author

romaricpascal commented Nov 27, 2023

After discussing on Slack and a quick try that showed that even with the visibility comments in, VSCode was still suggesting private/internal fields, we're going to keep things as they are and revisit at the point we'll discuss shipping types.

@romaricpascal romaricpascal moved this from To discuss to Done 🏁 in GOV.UK Design System cycle board Nov 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛 bug Something isn't working the way it should (including incorrect wording in documentation) javascript
Projects
Development

No branches or pull requests

1 participant