Algorithms should specify their return type in more cases. #581
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It's wrong to assert that return types are always easy to infer from algorithm steps and call sites. We also shouldn't make people read through the call sites (which might be in other documents) to figure out what an algorithm returns.
annevk
reviewed
May 26, 2023
| for algorithms that do return a value, since the return type is relatively easy to infer from the | ||
| algorithm steps and call sites: | ||
| for algorithms that do return a value if the return type is relatively easy to infer from the | ||
| algorithm steps: |
There was a problem hiding this comment.
Comma still seems good? Not entirely sure, but it's a pretty long sentence otherwise.
I was also thinking that we could say "nearby callers", but if you have to look at callers at all it's probably best clarified anyway.
There was a problem hiding this comment.
I removed the comma because before it was ok to skip the second half of the sentence, but now it's not ok. But I don't care very much. :)
domenic
approved these changes
May 31, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It's wrong to assert that return types are always easy to infer from
algorithm steps and call sites. We also shouldn't make people read
through the call sites (which might be in other documents) to figure out
what an algorithm returns.
Preview | Diff