Skip to content

Commit 0de69b9

Browse files
jeremyevansparacycle
authored andcommitted
[DOC] Update documentation for RB_{SCAN_ARGS,PASS}_KEYWORDS
When using RB_SCAN_ARGS_KEYWORDS or RB_PASS_KEYWORDS, the final argument must be a hash.
1 parent bae0772 commit 0de69b9

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

include/ruby/internal/scan_args.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,11 @@
4949
/** Same behaviour as rb_scan_args(). */
5050
#define RB_SCAN_ARGS_PASS_CALLED_KEYWORDS 0
5151

52-
/** The final argument should be a hash treated as keywords.*/
52+
/** The final argument must be a hash, which will be treated as keywords. */
5353
#define RB_SCAN_ARGS_KEYWORDS 1
5454

5555
/**
56-
* Treat a final argument as keywords if it is a hash, and not as keywords
56+
* Treat a final argument as keywords if it is a hash, and not as keywords
5757
* otherwise.
5858
*/
5959
#define RB_SCAN_ARGS_LAST_HASH_KEYWORDS 3
@@ -68,7 +68,7 @@
6868
/** Do not pass keywords. */
6969
#define RB_NO_KEYWORDS 0
7070

71-
/** Pass keywords, final argument should be a hash of keywords. */
71+
/** Pass keywords, final argument must be a hash of keywords. */
7272
#define RB_PASS_KEYWORDS 1
7373

7474
/**

0 commit comments

Comments
 (0)