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

Replace "may" with "might" to avoid ambiguity #1412

Merged
merged 1 commit into from
Aug 9, 2023

Conversation

jeffreyesun
Copy link
Contributor

As written, "Non-mutating functions may also use mutation under the hood" might imply that non-mutating functions are allowed to use mutation under the hood

[Please delete this text and describe your change here.
For bugfixes, please detail the bug and include a test case which your patch fixes.
If you are adding a new feature, please clearly describe the design, its rationale, the possible alternatives considered.
It is easiest to merge new features when there is clear precedent in other systems; we need to know we're taking
the right direction since it can be hard to change later.]

PR Checklist

  • Tests are added
  • Documentation, if applicable

As written, "Non-mutating functions may also use mutation under the hood" might imply that non-mutating functions are _allowed to_ use mutation under the hood
Copy link
Member

@ToucheSir ToucheSir left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if that note shouldn't be reworded to be even clearer (e.g. spell out what "non-mutating" means and how this includes functions the user may not even be aware of deep in the bowels of some (standard) library. Until that happens though, this seems like a reasonable change.

@ToucheSir ToucheSir merged commit 82c7a00 into FluxML:master Aug 9, 2023
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.

None yet

2 participants