Project

General

Profile

Misc #18404

Updated by zverok (Victor Shepelev) over 2 years ago

So far, comparing the NEWS.md to actual documentation at https://docs.ruby-lang.org/en/master/, I identified the following problems: 

 * ~~Hash/keyword argument value omission—completely undocumented. **PR: https://github.com/ruby/ruby/pull/5244**~~ Merged 
 * New [Refinement](https://docs.ruby-lang.org/en/master/Refinement.html) class has no docs whatsoever. **PR: https://github.com/ruby/ruby/pull/5272** 
 * ~~[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 
 * [Struct](https://docs.ruby-lang.org/en/master/Struct.html): `#keyword_init?` isn't mentioned anywhere. **PR: https://github.com/ruby/ruby/pull/5279** 
 * `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** has) 
 * [GC](https://docs.ruby-lang.org/en/master/GC.html): `::measure_total_time`, `::measure_total_time=`, `::total_time` isn't mentioned anywhere:  
 * [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`. **PR1: https://github.com/ruby/ruby/pull/5280** 
 * [IO::Buffer](https://docs.ruby-lang.org/en/master/IO/Buffer.html) no docs. **PR: https://github.com/ruby/ruby/pull/5302** 
 * `Random::Formatter`: the explanations of how to use it are murky, examples do show just context-less examples like `prng.hex(10)` https://docs.ruby-lang.org/en/master/Random/Formatter.html 

 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.

Back