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

Change createAlarm type property to enum in documentation #385

Merged
merged 1 commit into from
May 19, 2022
Merged

Change createAlarm type property to enum in documentation #385

merged 1 commit into from
May 19, 2022

Conversation

garv-shah
Copy link
Contributor

About this Pull Request

  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
    • It's a documentation update as using a string for the "type" property doesn't seem to work
  • What is the current behavior? (You can also link to an open issue here)
    • The documentation says that a string of 'display' or 'audio' can be assigned to the type property
  • What is the new behavior (if this is a feature change)?
    • The documentation now says that an enum of ICalAlarmType can be assigned to the type property
  • Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
    • nope :D
  • Other information:
    • If this was not the intended behaviour, maybe the functionality could be changed to accept the string?
    • Also, thank you so much for making the package, much appreciated :)

Pull Request Checklist

  • My code follows the code style of this project
    • Run npm run lint to double check
  • My change requires a change to the documentation
    • I have updated the documentation accordingly
  • I have added tests to cover my changes
    • Run npm run test to run the unit tests and npm run coverage to generate a coverage report
  • All new and existing tests passed
  • My commit messages follow the commit guidelines

@sebbo2002 sebbo2002 merged commit 8a7beb9 into sebbo2002:develop May 19, 2022
@sebbo2002
Copy link
Owner

Thank you for your contribution ❤️

@garv-shah
Copy link
Contributor Author

:))

@sebbo2002
Copy link
Owner

🎉 This PR is included in version 3.5.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants