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

docs: fix wording in "How it works" page #236

Merged
merged 1 commit into from
Mar 9, 2024

Conversation

yujiachen-y
Copy link
Contributor

I think it's better to replace 'SHOULD' by 'MUST'.

In the context of guidelines, recommendations, or requirements, "must" and "should" have distinct levels of obligation or expectation:

  • Must indicates a requirement, obligation, or something that is mandatory. It's used when there's no room for discretion or deviation from the directive. In legal or formal contexts, "must" signifies an absolute requirement.

  • Should suggests a recommendation or advice that is strongly encouraged but not mandatory. It implies that there are reasons or benefits to follow the guidance, but it's not an absolute requirement. There may be acceptable reasons or circumstances to deviate from a "should" directive.

So, when you see "must," think of it as a non-negotiable rule, whereas "should" is more of a strong suggestion that allows for some exceptions under certain conditions.

I think it's better to replace 'SHOULD' by 'MUST'.

In the context of guidelines, recommendations, or requirements, "must" and "should" have distinct levels of obligation or expectation:

- **Must** indicates a requirement, obligation, or something that is mandatory. It's used when there's no room for discretion or deviation from the directive. In legal or formal contexts, "must" signifies an absolute requirement.

- **Should** suggests a recommendation or advice that is strongly encouraged but not mandatory. It implies that there are reasons or benefits to follow the guidance, but it's not an absolute requirement. There may be acceptable reasons or circumstances to deviate from a "should" directive.

So, when you see "must," think of it as a non-negotiable rule, whereas "should" is more of a strong suggestion that allows for some exceptions under certain conditions.
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link

netlify bot commented Mar 9, 2024

Deploy Preview for casbin ready!

Name Link
🔨 Latest commit c21a91c
🔍 Latest deploy log https://app.netlify.com/sites/casbin/deploys/65ec0e685498880008fdd40c
😎 Deploy Preview https://deploy-preview-236--casbin.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@yujiachen-y yujiachen-y changed the title Update HowItWorks.mdx docs: update HowItWorks.mdx Mar 9, 2024
@hsluoyz hsluoyz changed the title docs: update HowItWorks.mdx docs: fix wording in "How it works" page Mar 9, 2024
@hsluoyz hsluoyz merged commit f6fc565 into casbin:master Mar 9, 2024
7 of 9 checks passed
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.

3 participants