diff options
| author | zverok <[email protected]> | 2022-12-21 21:23:14 +0200 |
|---|---|---|
| committer | Victor Shepelev <[email protected]> | 2022-12-23 18:09:49 +0200 |
| commit | b3d57fdd64d2e88499bf718e64522dfce9358c48 () | |
| tree | 584cdf2252deef55054cbe20f3a32ad1eb5b0d1b /struct.c | |
| parent | 91076b2c595a83fd55b49f907b2f9d84d264e5a2 (diff) | |
Docs: Update Struct docs about keyword initialization
Notes: Merged: https://.com/ruby/ruby/pull/6985
| -rw-r--r-- | struct.c | 47 |
1 files changed, 31 insertions, 16 deletions
@@ -524,8 +524,7 @@ rb_struct_define_under(VALUE outer, const char *name, ...) * * - May be anonymous, or may have the name given by +class_name+. * - May have members as given by +member_names+. - * - May have initialization via ordinary arguments (unless - * <tt>keyword_init: true</tt> is given), or via keyword arguments * * The new subclass has its own method <tt>::new</tt>; thus: * @@ -594,6 +593,12 @@ rb_struct_define_under(VALUE outer, const char *name, ...) * Foo.new(0, 1) # => #<struct Struct::Foo foo=0, bar=1> * Foo.new(0, 1, 2) # Raises ArgumentError: struct size differs * * \Method <tt>::[]</tt> is an alias for method <tt>::new</tt>. * * - \Method <tt>:inspect</tt> returns a string representation of the subclass: @@ -608,20 +613,30 @@ rb_struct_define_under(VALUE outer, const char *name, ...) * <b>Keyword Argument</b> * * By default, the arguments for initializing an instance of the new subclass - * are ordinary arguments (not keyword arguments). - * With optional keyword argument <tt>keyword_init: true</tt>, - * the new subclass must be initialized with keyword arguments: - * - * # Without keyword_init: true. - * Foo = Struct.new('Foo', :foo, :bar) - * Foo # => Struct::Foo - * Foo.new(0, 1) # => #<struct Struct::Foo foo=0, bar=1> - * # With keyword_init: true. - * Bar = Struct.new(:foo, :bar, keyword_init: true) - * Bar # => # => Bar(keyword_init: true) - * Bar.new(bar: 1, foo: 0) # => #<struct Bar foo=0, bar=1> - * Bar.new(0, 1) # Raises ArgumentError: wrong number of arguments - * */ static VALUE |