From: "ioquatix (Samuel Williams)" Date: 2021-12-11T20:31:38+00:00 Subject: [ruby-core:106624] [Ruby master Misc#18404] 3.1 documentation problems tracking ticket Issue #18404 has been updated by ioquatix (Samuel Williams). `IO::Buffer` is also totally undocumented. ---------------------------------------- Misc #18404: 3.1 documentation problems tracking ticket https://bugs.ruby-lang.org/issues/18404#change-95291 * 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: * Hash/keyword argument value omission���completely undocumented. PR: https://github.com/ruby/ruby/pull/5244 * New [Refinement](https://docs.ruby-lang.org/en/master/Refinement.html) class has no docs whatsoever. * [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`) * [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 * [Struct](https://docs.ruby-lang.org/en/master/Struct.html): `#keyword_init?` isn't mentioned anywhere * `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) * [GC](https://docs.ruby-lang.org/en/master/GC.html): `::measure_total_time`, `::measure_total_time=`, `::total_time` isn't mentioned anywhere: 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: