Skip to content

Fix small documentation problems #6985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 6 commits into from
Dec 23, 2022
Merged

Fix small documentation problems #6985

merged 6 commits into from
Dec 23, 2022

Conversation

zverok
Copy link
Contributor

@zverok zverok commented Dec 21, 2022 •
edited
Loading

Fix part of the problems described in #19247:

  • rendering of SyntaxError#path (and LoadError#path);
  • Update Struct docs about keyword initialization
  • Add list of keys to Time#deconstruct_keys fixed by @k-tsj b7bb14b
  • Separate documentation for UnboundMethod#== from Method#== (behavior is different)
  • Fix small glitch in GC docs (wrong rendering of mid-doc indent)
  • path: option for IO.new
  • Fix problems with Fiber's docs
    • References to Scheduler (was outdated to SchedulerInterface)
    • References between new methods (storage, [], []=)
    • storage call-sequence (rendered confusingly)

@zverok zverok requested review from jeremyevans and nobu December 21, 2022 20:14
@nobu nobu added the Documentation Improvements to documentation. label Dec 22, 2022
nobu
nobu reviewed Dec 22, 2022
View reviewed changes
@nobu
Copy link
Member

nobu commented Dec 22, 2022

The tags need to be [DOC] to skip unnecessary CIs, instead of Docs:.

jeremyevans
jeremyevans requested changes Dec 22, 2022
View reviewed changes
@zverok zverok requested review from jeremyevans and nobu December 22, 2022 21:00
@zverok zverok merged commit d61a4ce into ruby:master Dec 23, 2022
@zverok zverok deleted the fix-docs-dec-2022 branch December 23, 2022 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jeremyevans jeremyevans jeremyevans approved these changes

@nobu nobu Awaiting requested review from nobu

Assignees
No one assigned
Labels
Documentation Improvements to documentation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@zverok @nobu @jeremyevans