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

[Discussion] variant names of MSK* are misleading #830

Open
eZioPan opened this issue Apr 7, 2023 · 0 comments · May be fixed by #853
Open

[Discussion] variant names of MSK* are misleading #830

eZioPan opened this issue Apr 7, 2023 · 0 comments · May be fixed by #853

Comments

@eZioPan
Copy link
Contributor

eZioPan commented Apr 7, 2023

"MSK*":
Mask: [0, "Alarm set if the date/day match"]
NotMask: [1, "Date/day don’t care in Alarm comparison"]

In my opinion, value 0 should have NotMasked variant, and value 1 should have Masked, which is also aligned with NVIC concept: set unmask then some function activate, set mask then some function deactivate.

Or even better, I suggest to use

 "MSK1": Alarm seconds mask
   ToMatch: [0, "Alarm set if the date/day match"] 
   NotCare: [1, "Seconds don’t care in Alarm comparison"] 

to make this values more clearly.

But this modification will break current api, so maybe we need more discussion on it?

and also, MSK1 ~ MSK4 share the same description, which is not correct, and need to be too.

@eZioPan eZioPan changed the title [Discussion] variant name of MSK* are misleading [Discussion] variant names of MSK* are misleading Apr 7, 2023
@eZioPan eZioPan linked a pull request Jun 12, 2023 that will close this issue
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 a pull request may close this issue.

1 participant