Issue #19247 has been updated by zverok (Victor Shepelev). https://github.com/ruby/ruby/pull/6985 Fixes: * Fiber * SyntaxError * Struct * Time * UnboundMethod * GC I plan to do at least two more before the release: * One documenting all the changes in `Fiber::Scheduler` and `IOBuffer` * One documenting `AbstractSyntaxTree` options and behaviors (besides new options for `initialize`, there are new methods in `Node`, and some were missed in 3.0, too) * (Maybe) One with wording/examples improvement for newly introduced methods, where it is not critical. ---------------------------------------- Misc #19247: Ruby 3.2 documentation problems tracker https://bugs.ruby-lang.org/issues/19247#change-100742 * Author: zverok (Victor Shepelev) * Status: Open * Priority: Normal * Assignee: zverok (Victor Shepelev) ---------------------------------------- Bugs and problems: * [Fiber](https://docs.ruby-lang.org/en/master/Fiber.html): * Formatting glitches for `::[]`, `::[]=`, `::storage`, `::storage=` (no references to companion methods) * Also there are some rendering glitches in Fiber, due to RDoc update? (Source didn't change) * After renaming SchedulerInterface to Scheduler, reference to it from Fiber are lost * [FiberScheduler](https://docs.ruby-lang.org/en/master/Fiber/Scheduler.html) has no docs for new method `#io_select` * [SyntaxError](https://docs.ruby-lang.org/en/master/SyntaxError.html): new attribute `#path` wrongly rendered * [RubyVM::AbstractSyntaxTree](https://docs.ruby-lang.org/en/master/RubyVM/AbstractSyntaxTree.html): `error_tolerant:` and `keep_tokens:` options aren't documented or mentioned in the docs * [Set](https://docs.ruby-lang.org/en/master/Set.html): docs still start with `require 'set'` :) * [Struct](https://docs.ruby-lang.org/en/master/Struct.html): no mention of the changed requirement about keyword initialization. * [Time#deconstruct_keys](https://docs.ruby-lang.org/en/master/Time.html#method-i-deconstruct_keys) instead of listing keys refers to "the same as returned by to_h", which we decided not to implement, my bad! * [UnboundMethod#==](https://docs.ruby-lang.org/en/master/UnboundMethod.html#method-i-3D-3D) says that methods are equal if are bound to the same object :) (shares docs with `Method`?..) * [GC::latest_gc_info](https://docs.ruby-lang.org/en/master/GC.html#method-c-latest_gc_info) rendering glitch (old probably). It also lacks any docs about the structure of the hash returned. * [ObjectSpace.dump_all](https://docs.ruby-lang.org/en/master/ObjectSpace.html#method-i-dump_all) and several companion methods are weirdly documented as instance methods (RDoc glitch, doubtfully easy to fix) Things that could be improved: * [Module#undefined_instance_methods](https://docs.ruby-lang.org/en/master/Module.html#method-i-undefined_instance...) is not really helpful :) * [Refinement#refined_class](https://docs.ruby-lang.org/en/master/Refinement.html#method-i-refined_class) can use better explanation/example? * [Thread::each_caller_location](https://docs.ruby-lang.org/en/master/Thread.html#method-c-each_caller_locati...) can use an example? (Also wrongly referred as instance method in [NEWS](https://docs.ruby-lang.org/en/master/NEWS_md.html#label-Core+classes+updates)) I'll try to work on those ASAP. -- https://bugs.ruby-lang.org/

Issue #19247 has been updated by zverok (Victor Shepelev). https://github.com/ruby/ruby/pull/6996 adds missing AST keyword arguments docs. ---------------------------------------- Misc #19247: Ruby 3.2 documentation problems tracker https://bugs.ruby-lang.org/issues/19247#change-100761 * Author: zverok (Victor Shepelev) * Status: Open * Priority: Normal * Assignee: zverok (Victor Shepelev) ---------------------------------------- Bugs and problems: * [Fiber](https://docs.ruby-lang.org/en/master/Fiber.html): * Formatting glitches for `::[]`, `::[]=`, `::storage`, `::storage=` (no references to companion methods) * Also there are some rendering glitches in Fiber, due to RDoc update? (Source didn't change) * After renaming SchedulerInterface to Scheduler, reference to it from Fiber are lost * [FiberScheduler](https://docs.ruby-lang.org/en/master/Fiber/Scheduler.html) has no docs for new method `#io_select` * [SyntaxError](https://docs.ruby-lang.org/en/master/SyntaxError.html): new attribute `#path` wrongly rendered * [RubyVM::AbstractSyntaxTree](https://docs.ruby-lang.org/en/master/RubyVM/AbstractSyntaxTree.html): `error_tolerant:` and `keep_tokens:` options aren't documented or mentioned in the docs * [Set](https://docs.ruby-lang.org/en/master/Set.html): docs still start with `require 'set'` :) * [Struct](https://docs.ruby-lang.org/en/master/Struct.html): no mention of the changed requirement about keyword initialization. * [Time#deconstruct_keys](https://docs.ruby-lang.org/en/master/Time.html#method-i-deconstruct_keys) instead of listing keys refers to "the same as returned by to_h", which we decided not to implement, my bad! * [UnboundMethod#==](https://docs.ruby-lang.org/en/master/UnboundMethod.html#method-i-3D-3D) says that methods are equal if are bound to the same object :) (shares docs with `Method`?..) * [GC::latest_gc_info](https://docs.ruby-lang.org/en/master/GC.html#method-c-latest_gc_info) rendering glitch (old probably). It also lacks any docs about the structure of the hash returned. * [ObjectSpace.dump_all](https://docs.ruby-lang.org/en/master/ObjectSpace.html#method-i-dump_all) and several companion methods are weirdly documented as instance methods (RDoc glitch, doubtfully easy to fix) Things that could be improved: * [Module#undefined_instance_methods](https://docs.ruby-lang.org/en/master/Module.html#method-i-undefined_instance...) is not really helpful :) * [Refinement#refined_class](https://docs.ruby-lang.org/en/master/Refinement.html#method-i-refined_class) can use better explanation/example? * [Thread::each_caller_location](https://docs.ruby-lang.org/en/master/Thread.html#method-c-each_caller_locati...) can use an example? (Also wrongly referred as instance method in [NEWS](https://docs.ruby-lang.org/en/master/NEWS_md.html#label-Core+classes+updates)) I'll try to work on those ASAP. UPD 2022-12-21: * [IO#Open Options](https://docs.ruby-lang.org/en/master/IO.html#class-IO-label-Open+Options) don't mention `path:`. -- https://bugs.ruby-lang.org/

Issue #19247 has been updated by zverok (Victor Shepelev). Status changed from Open to Closed I did what I could before the release, the other problems can be handled separately through the year. ---------------------------------------- Misc #19247: Ruby 3.2 documentation problems tracker https://bugs.ruby-lang.org/issues/19247#change-101401 * Author: zverok (Victor Shepelev) * Status: Closed * Priority: Normal * Assignee: zverok (Victor Shepelev) ---------------------------------------- Bugs and problems: * [Fiber](https://docs.ruby-lang.org/en/master/Fiber.html): * Formatting glitches for `::[]`, `::[]=`, `::storage`, `::storage=` (no references to companion methods) * Also there are some rendering glitches in Fiber, due to RDoc update? (Source didn't change) * After renaming SchedulerInterface to Scheduler, reference to it from Fiber are lost * [FiberScheduler](https://docs.ruby-lang.org/en/master/Fiber/Scheduler.html) has no docs for new method `#io_select` * [SyntaxError](https://docs.ruby-lang.org/en/master/SyntaxError.html): new attribute `#path` wrongly rendered * [RubyVM::AbstractSyntaxTree](https://docs.ruby-lang.org/en/master/RubyVM/AbstractSyntaxTree.html): `error_tolerant:` and `keep_tokens:` options aren't documented or mentioned in the docs * [Set](https://docs.ruby-lang.org/en/master/Set.html): docs still start with `require 'set'` :) * [Struct](https://docs.ruby-lang.org/en/master/Struct.html): no mention of the changed requirement about keyword initialization. * [Time#deconstruct_keys](https://docs.ruby-lang.org/en/master/Time.html#method-i-deconstruct_keys) instead of listing keys refers to "the same as returned by to_h", which we decided not to implement, my bad! * [UnboundMethod#==](https://docs.ruby-lang.org/en/master/UnboundMethod.html#method-i-3D-3D) says that methods are equal if are bound to the same object :) (shares docs with `Method`?..) * [GC::latest_gc_info](https://docs.ruby-lang.org/en/master/GC.html#method-c-latest_gc_info) rendering glitch (old probably). It also lacks any docs about the structure of the hash returned. * [ObjectSpace.dump_all](https://docs.ruby-lang.org/en/master/ObjectSpace.html#method-i-dump_all) and several companion methods are weirdly documented as instance methods (RDoc glitch, doubtfully easy to fix) Things that could be improved: * [Module#undefined_instance_methods](https://docs.ruby-lang.org/en/master/Module.html#method-i-undefined_instance...) is not really helpful :) * [Refinement#refined_class](https://docs.ruby-lang.org/en/master/Refinement.html#method-i-refined_class) can use better explanation/example? * [Thread::each_caller_location](https://docs.ruby-lang.org/en/master/Thread.html#method-c-each_caller_locati...) can use an example? (Also wrongly referred as instance method in [NEWS](https://docs.ruby-lang.org/en/master/NEWS_md.html#label-Core+classes+updates)) I'll try to work on those ASAP. UPD 2022-12-21: * [IO#Open Options](https://docs.ruby-lang.org/en/master/IO.html#class-IO-label-Open+Options) don't mention `path:`. -- https://bugs.ruby-lang.org/