Skip to content
Prev Previous commit
Next Next commit
Update Doc/c-api/intro.rst
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
  • Loading branch information
Yashp002 and StanFromIreland authored Nov 15, 2025
commit 4234c8b52b843618c43f5c4db112f7f1ce9dd927
1 change: 1 addition & 0 deletions Doc/c-api/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,7 @@ complete listing.
not a pointer. Using this macro with a pointer will produce incorrect results.
Comment thread
Yashp002 marked this conversation as resolved.
Outdated

This is generally equivalent to::

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I don't like the use of "generally" equivalent because it may indicate that it's equivalent to something else. So I would remove the "This is generally equivalent to:: + code"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I disagree, it's helpful to have something rather than nothing, even if it's not 100% true. This is a good example of a lie-to-children.

If you're against "generally", how about saying "this is semantically equivalent to ..."?

@picnixz picnixz Nov 19, 2025 •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

"generally" is inaccurate; if you want to lie a bit, you should say "roughly equivalent to" (which is what we do in academia or in itertools btw). "Generally" means that this would always be the case (at least to me when used like that), but the macro expansion is different.

  • If you want to use "generally" as a synonym of "usually", "roughly" is better.
  • "semantically equivalent" is too verbose IMO.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

"roughly equivalent to" is fine with me.


sizeof(array) / sizeof((array)[0])

Comment thread
Yashp002 marked this conversation as resolved.

Expand Down
Loading