Actions
Misc #18404
closed3.1 documentation problems tracking ticket
Status:
Closed
Assignee:
-
Description
So far, comparing the NEWS.md to actual documentation at https://docs.ruby-lang.org/en/master/, I identified the following problems:
-
Random::Formatter: the explanations of how to use it are murky, examples do show just context-less examples like
prng.hex(10)
Merged:
-
Hash/keyword argument value omission—completely undocumented. PR: https://github.com/ruby/ruby/pull/5244Merged -
Queue::new should be rewritten (bad rendering for example, non-informative parameter name). PR: https://github.com/ruby/ruby/pull/5273Merged -
MergedThread::Backtrace.limit
isn't mentioned anywhere (Thread::Backtrace
doesn't even have its own page, only Thread::Backtrace::Location has). PR: https://github.com/ruby/ruby/pull/5305 -
Fiber::SchedulerInterfaceMerged
— no docs for new methods supported:address_resolve
,timeout_after
,io_read
,io_write
. PR: https://github.com/ruby/ruby/pull/5280 -
New Refinement class has no docs whatsoever. PR: https://github.com/ruby/ruby/pull/5272Merged -
Struct:Merged#keyword_init?
isn't mentioned anywhere. PR: https://github.com/ruby/ruby/pull/5279 -
GC:Merged::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 -
String#unpack and #unpack1: newMergedoffset
param examples are given too early, before the main examples.unpack1
also has code formatting glitch. PR: https://github.com/ruby/ruby/pull/5331 -
Marshal#load: the new parameterMergedfreeze:
is not documented. PR: https://github.com/ruby/ruby/pull/5332 -
IO::Buffer no docs. PR: https://github.com/ruby/ruby/pull/5302Merged by hand by @ioquatix (Samuel Williams)
Small glitches in new docs:
-
Process._fork formatting ofMergedtt
. PR: https://github.com/ruby/ruby/pull/5270 -
Integer#try_convert: small typo: "Returns nil if object does not respond to :to_ary" (should beFixed already.:to_int
).
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.
Actions
Like0
Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0Like0