From: "zverok (Victor Shepelev) via ruby-core" <ruby-core@...>
Date: 2022-12-23T21:46:38+00:00
Subject: [ruby-core:111414] [Ruby master Misc#19247] Ruby 3.2 documentation problems tracker

Issue #19247 has been updated by zverok (Victor Shepelev).





https://github.com/ruby/ruby/pull/7016 `Fiber::Scheduler` and `IO::Buffer` missing methods.



@jeremyevans0 sorry, I tagged you in both, you are usually the quickest to respond, and time is tight ����



Next year, I plan to follow the development with my changelog and doc fixes throughout the year instead of trying to squeeze it all in December.



----------------------------------------

Misc #19247: Ruby 3.2 documentation problems tracker

https://bugs.ruby-lang.org/issues/19247#change-100786



* 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_methods) 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_location) 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/

 ______________________________________________
 ruby-core mailing list -- ruby-core@ml.ruby-lang.org
 To unsubscribe send an email to ruby-core-leave@ml.ruby-lang.org
 ruby-core info -- https://ml.ruby-lang.org/mailman3/postorius/lists/ruby-core.ml.ruby-lang.org/