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

refactor(w3c/level): improve method docs #4623

Merged
merged 6 commits into from
Apr 9, 2024
Merged

refactor(w3c/level): improve method docs #4623

merged 6 commits into from
Apr 9, 2024

Conversation

marcoscaceres
Copy link
Contributor

No description provided.

@sidvishnoi
Copy link
Member

I'm not finding the benefit of this particular class of refactor. How does typescript help here?

@marcoscaceres
Copy link
Contributor Author

marcoscaceres commented Dec 29, 2023

The LocalizationStrings helps remind us to add all the supported languages. So, although it's not super useful here, it's going to be useful in other places where we have localization language gaps.

Copy link
Member

@sidvishnoi sidvishnoi left a comment

Choose a reason for hiding this comment

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

I'm in favor of grouping all these PRs into bigger chunks.

Nits to be followed:

  1. Make this comment appear in one line.
    - /**
    - * @type {LocalizationStrings}
    - */
    + /** @type {LocalizationStrings} */
  2. Remove this "Localization data based on the user's language preference." comment as it's noisy.

src/w3c/level.js Outdated Show resolved Hide resolved
src/w3c/level.js Outdated Show resolved Hide resolved
@sidvishnoi sidvishnoi merged commit 0072750 into main Apr 9, 2024
8 checks passed
@sidvishnoi sidvishnoi deleted the w3c-level branch April 9, 2024 06:27
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