Actions
Misc #17422
closed3.0 documentation problems tracking ticket
Status:
Closed
Assignee:
-
Description
A meta-ticket for tracking all documentation problems with 3.0's new features (which hopefully should be fixed before the release). I plan to work on those myself, but I have only so much time, so the help would be appreciated.
- Missing docs for new methods:
-
mergedSymbol#name
,Proc#==
,Fiber#backtrace
(more or less trivial, handled by https://github.com/ruby/ruby/pull/3966)
-
- Method docs to be changed
-
mergedFiber#transfer
changed limitations -- requires thorough redocumenting of#transfer
, its use cases and limitations: https://github.com/ruby/ruby/pull/3981 -
Module#include
/#prepend
-- I'd say the docs should be rewritten (now they are from the "internal" point of view), and only then there would be a place to describe the behavior change;
-
- Larger chunks:
-
doc/syntax/methods.rdoc
-- no sign of...
or "endless" methods: https://github.com/ruby/ruby/pull/3997 to review -
Fiber scheduler and non-blocking fibers: my take is https://github.com/ruby/ruby/pull/3891 / #17389, now it is up to @ioquatix (Samuel Williams) to accept/reject or do it his waymerged -
doc/syntax/pattern_matching.rdoc
-- should be reviewed, cleaned up (at least formatting) and probably structured better after reintroduction of two kinds of one-line matching;
-
- Should it be updated?
-
doc/syntax/assignment.rdoc
-- "Class Variable" section, include more explanation on visibility (and new exceptions on "overtaking")? -
Kernel#lambda
-- include info on "only literal blocks"? -
Symbol#to_proc
-- explain about the block's lambdiness? -
Mutex
-- mention it is owned per-Fiber?
-
- Documentation bugs:
-
mergedRandom
lost definitions of instance methods: fixed by https://github.com/ruby/ruby/pull/3966 -
Kernel
: lost docs for several methods (like #abort, but also#exec
,#exit
) due toNO_RETURN
macro, I am not yet sure how to fix it (moving comment before macro does not help)
-
To be continued...
Actions
Like0
Like0Like0Like0Like0Like0