Skip to content

Documentation needs backporting #111

@zverok

Description

@zverok

docs.ruby-lang.org renders docs only for major versions: there is docs for 2.7.0, but not for 2.7.1 -- which implies that https://docs.ruby-lang.org/en/2.7.0/ actually contains "Generic 2.7 docs". At the same time, documentation is frequently fixed after the release. This way, documentation that is relevant for version x.y.*, but was NOT there at x.y.0 will NEVER be rendered. Some examples:

  1. What's the pattern matching syntax for 2.7? The PM docs were written after the release, so they are accessible by https://docs.ruby-lang.org/en/3.0.0/doc/syntax/pattern_matching_rdoc.html (it is 3.0's PM!), or https://docs.ruby-lang.org/en/master/doc/syntax/pattern_matching_rdoc.html (was 2.7's before 3.0's release, now it is 3.0's too).
  2. My method definition docs update was merged AFTER the 3.0 release. So endless methods and ... argument forwarding are documented here: https://docs.ruby-lang.org/en/master/doc/syntax/methods_rdoc.html, but not here: https://docs.ruby-lang.org/en/3.0.0/doc/syntax/methods_rdoc.html (implying they aren't in 3.0 at all)

I believe that something should be done about it, probably at least on releasing 3.0.1 its docs should be merged into 3.0.0 URL, or maybe rendered separately at https://docs.ruby-lang.org/en/3.0.1. Or, maybe, the docs should actually be backported into 3.0.0? Because if the Ruby installed with the local docs, 3.0.0 would forever lack them.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions