Skip to content

[P.6] copyedit: Move a comment for consistency, change "a" to "the", and fix a typo: "f" to "f2" #2288

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.

Sign up for GitHub

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

[P.6] copyedit: Move a comment for consistency, change "a" to "the", and fix a typo: "f" to "f2" #2288

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
80ddcb0
[P.6] trivial: s/f/f2/ (#2288)
mfwitten Sep 29, 2025
812cea6
[P.6] trivial: Move a code comment (//...) to the line above the code…
mfwitten Sep 29, 2025
3c459b5
[P.6] trivial: s/a/the/ (#2288)
mfwitten Sep 29, 2025
25c6708
[P.6] copyedit: Move a comment for consistency, change "a" to "the", …
mfwitten Sep 29, 2025
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
3 changes: 2 additions & 1 deletion CppCoreGuidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -767,7 +767,8 @@ We can of course pass the number of elements along with the pointer:

void g2(int n)
{
f2(new int[n], n); // bad: a wrong number of elements can be passed to f()
// bad: the wrong number of elements can be passed to f2()
f2(new int[n], n);
}

Passing the number of elements as an argument is better (and far more common) than just passing the pointer and relying on some (unstated) convention for knowing or discovering the number of elements. However (as shown), a simple typo can introduce a serious error. The connection between the two arguments of `f2()` is conventional, rather than explicit.
Expand Down