Skip to content

[DOC] Tweaks for Hash#clear #12727

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

Merged
peterzhu2118 merged 1 commit into from
Feb 10, 2025
Merged

[DOC] Tweaks for Hash#clear #12727

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 hash.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2845,9 +2845,9 @@ clear_i(VALUE key, VALUE value, VALUE dummy)

/*
* call-seq:
* hash.clear -> self
* clear -> self
Copy link
Member

@peterzhu2118 peterzhu2118 Feb 10, 2025

Choose a reason for hiding this comment

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

The other call-seq seems to standardize on having hash. prepended.

Suggested change
* clear -> self
* hash.clear -> self

Copy link
Member Author

@BurdetteLamar BurdetteLamar Feb 10, 2025

Choose a reason for hiding this comment

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

The other call-seq seems to standardize on having hash. prepended.

Doc guide says not: https://docs.ruby-lang.org/en/master/contributing/documentation_guide_md.html#label-Calling+Sequence+-28for+methods+written+in+C-29.

Will change the others as we go.

Copy link
Member

@peterzhu2118 peterzhu2118 Feb 10, 2025

Choose a reason for hiding this comment

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

I see, I fixed all of them in Hash and Array in #12728 to make it consistent.

*
* Removes all hash entries; returns +self+.
* Removes all entries from +self+; returns emptied +self+.
*/

VALUE
Expand Down