vega-lite icon indicating copy to clipboard operation
vega-lite copied to clipboard

fix: typo in MultiTimeUnit declaration

Open jkillian opened this issue 2 years ago • 1 comments

Fixes a typo in MULTI_TIMEUNIT declaration where a value was specified as "weeksdayhours" instead of "weekdayhours".

I'm not sure if this is a breaking change - if people are validating a Vega-Lite schema and have weeksdayhours values in it, the validation will now fail. However, it seems like the old value was a clear mistake as every other value uses a singular week and not a plural weeks, so maybe it makes sense to fix this anyways if it falls into the "bug" category of change? Up to you all of course, feel free to do with this PR whatever is best!

Please:

  • [x] Make the pull requests (PRs) atomic (fix one issue at a time). Multiple relevant issues that must be fixed together? Make atomic commits so we can easily review each issue.
  • [x] Provide a concise title as a semantic commit message (e.g. "fix: correctly handle undefined properties") so we can easily copy it to the release note.
    • Use imperative mood and present tense.
  • Mention relevant issues in the description (e.g., Fixes #1 / Fixes part of #1).
  • [x] Lint and test (Run yarn test).
  • [x] If you send a pull request from a fork, make sure that GitHub actions run successfully. Make sure to add a GH_PAT secret for a personal access token with public repository permissions.
  • [x] Review your changes before sending the PR (to ensure code quality).
  • For new features:
    • [ ] Add new unit tests.
    • [ ] Update the documentation under site/docs/ + add examples.

Tips:

  • https://medium.com/@greenberg/writing-pull-requests-your-coworkers-might-enjoy-reading-9d0307e93da3 is a nice article about writing a nice PR.
  • Use draft PR for work in progress PRs / when you want early feedback (https://github.blog/2019-02-14-introducing-draft-pull-requests/).

jkillian avatar Jun 13 '22 21:06 jkillian

This looks like a bug we should fix. Thanks for the pull request.

domoritz avatar Jun 13 '22 23:06 domoritz