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

Updates Documentation from Strings to Units #2838

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

conor-f
Copy link

@conor-f conor-f commented Feb 11, 2025

In many places the documentation suggested that the only types a method could take were strings like miles or kilometers when the code actually supported all Units. Updated this in any place I could find using grep to find the files that needed changes, and manually updating the comments.

This is a non-breaking change.

Supercedes #2218 but fixes no open issues.

Please provide the following when creating a PR:

  • Meaningful title, including the name of the package being modified.
  • Summary of the changes.
  • Heads up if this is a breaking change.
  • Any issues this resolves.
  • Inclusion of your details in the contributors field of package.json - you've earned it! 👏
  • Confirmation you've read the steps for preparing a pull request.

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.

1 participant