[ruby-core:106799] [Ruby master Misc#18404] 3.1 documentation problems tracking ticket

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


Folks, maybe that's not obvious but **I don't have commit rights**. 
So, unless somebody merges the PRs that are listed above—the **docs for those features will be missing**.

cc @nobu (I don't know who else I should tag, please advise)

----------------------------------------
Misc #18404: 3.1 documentation problems tracking ticket
https://bugs.ruby-lang.org/issues/18404#change-95559

* Author: zverok (Victor Shepelev)
* Status: Open
* Priority: Normal
----------------------------------------
So far, comparing the NEWS.md to actual documentation at https://docs.ruby-lang.org/en/master/, I identified the following problems:

* New [Refinement](https://docs.ruby-lang.org/en/master/Refinement.html) class has no docs whatsoever. **PR: https://github.com/ruby/ruby/pull/5272**
* [Struct](https://docs.ruby-lang.org/en/master/Struct.html): `#keyword_init?` isn't mentioned anywhere. **PR: https://github.com/ruby/ruby/pull/5279**
* [GC](https://docs.ruby-lang.org/en/master/GC.html): `::measure_total_time`, `::measure_total_time=`, `::total_time` isn't mentioned anywhere. UPD: was just a documentation rendering glitch, **PR: https://github.com/ruby/ruby/pull/5306**
* [Random::Formatter](https://docs.ruby-lang.org/en/master/Random/Formatter.html): the explanations of how to use it are murky, examples do show just context-less examples like `prng.hex(10)` 
* [IO::Buffer](https://docs.ruby-lang.org/en/master/IO/Buffer.html) no docs. ~~PR: https://github.com/ruby/ruby/pull/5302~~ Will be merged by hand by @ioquatix
* [Marshal#load](https://docs.ruby-lang.org/en/master/Marshal.html#method-c-load): the new parameter `freeze:` is not documented. **PR: https://github.com/ruby/ruby/pull/5332**

Merged:
* ~~Hash/keyword argument value omission—completely undocumented. PR: https://github.com/ruby/ruby/pull/5244~~ Merged
* ~~[Queue::new](https://docs.ruby-lang.org/en/master/Thread/Queue.html#method-c-new) should be rewritten (bad rendering for example, non-informative parameter name). PR: https://github.com/ruby/ruby/pull/5273~~ Merged
* ~~`Thread::Backtrace.limit` isn't mentioned anywhere (`Thread::Backtrace` doesn't even have its own page, only [Thread::Backtrace::Location](https://docs.ruby-lang.org/en/master/Thread/Backtrace/Location.html) has). PR: https://github.com/ruby/ruby/pull/5305~~ Merged
* ~~[Fiber::SchedulerInterface
](https://docs.ruby-lang.org/en/master/Fiber/SchedulerInterface.html) — no docs for new methods supported: `address_resolve`, `timeout_after`, `io_read`, `io_write`. PR: https://github.com/ruby/ruby/pull/5280~~ Merged
* ~~[String#unpack](https://docs.ruby-lang.org/en/master/String.html#method-i-unpack) and [#unpack1](https://docs.ruby-lang.org/en/master/String.html#method-i-unpack1): new `offset` param examples are given too early, before the main examples. `unpack1` also has code formatting glitch. PR: https://github.com/ruby/ruby/pull/5331~~ Merged


Small glitches in new docs:
* ~~[Process._fork](https://docs.ruby-lang.org/en/master/Process.html#method-c-_fork) formatting of `tt`. PR: https://github.com/ruby/ruby/pull/5270~~ Merged
* ~~[Integer#try_convert](https://docs.ruby-lang.org/en/master/Integer.html#method-c-try_convert):  small typo: "Returns nil if object does not respond to **:to_ary**" (should be `:to_int`).~~ Fixed already.


I'll try to address as much as I'll be able myself, but if some of the feature authors/other volunteers are willing to participate, I'll be glad :)

The ticket might be expanded if I'll notice something else.



-- 
https://bugs.ruby-lang.org/

Unsubscribe: <mailto:[e-mail]?subject=unsubscribe>
<http://lists.ruby-lang.org/cgi-bin/mailman/options/ruby-core>