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

Algorithms should specify their return type in more cases. #581

Merged
merged 1 commit into from
May 31, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions infra.bs
Original file line number Diff line number Diff line change
Expand Up @@ -297,8 +297,8 @@ a [=byte sequence=] <var ignore>bytes</var>, perform the following steps. They r
[=string=] or null.

<p>Algorithms which do not return a value use a shorter form. This same shorter form can be used even
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:
Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Member Author

Choose a reason for hiding this comment

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

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. :)


<p class=exemplary-prose>To <dfn ignore>[algorithm name]</dfn>, given a [type1]
<var ignore>[parameter1]</var>, a [type2] <var ignore>[parameter2]</var>, &hellip;:</p>
Expand Down