Project

General

Profile

Misc #16126

Fix small docs inconsistencies

Added by zverok (Victor Shepelev) about 2 months ago. Updated about 2 months ago.

Status:
Closed
Priority:
Normal
Assignee:
-
[ruby-core:94536]

Description

The patch with some small-ish fixes:

  • Enumerator refers to #enum_for/#to_enum under Kernel, while in fact they are documented under Object;
  • Kernel#warn has outdated call sequence;
  • ClosedQueueError is not mentioned in errors hierarchy;
  • then is referred to as yield_self, obscuring the usage.

Not fixed yet, though should be:

For the next, step, I plan to provide a PRs with core and stdlib docs that are just missing, outdated or confusing.


Files

docs-bugs.patch (2.99 KB) docs-bugs.patch zverok (Victor Shepelev), 08/24/2019 05:35 PM

Associated revisions

Revision 04735c48
Added by jeremyevans (Jeremy Evans) about 2 months ago

Minor documentation fixes [ci skip]

From zverok (Victor Shepelev)

Fixes [Misc #16126]

History

Updated by jeremyevans0 (Jeremy Evans) about 2 months ago

Thanks for the patch, I will merge it shortly.

#2

Updated by jeremyevans (Jeremy Evans) about 2 months ago

  • Status changed from Open to Closed

Applied in changeset git|04735c48ab44c97cbfd5a5cd37f9a1696e2f5a2b.


Minor documentation fixes [ci skip]

From zverok (Victor Shepelev)

Fixes [Misc #16126]

Also available in: Atom PDF