Skip to content
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.

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

Repaired What's Here sections for Range, String, Symbol, Struct #5735

Merged
merged 2 commits into from Mar 30, 2022
Merged

Repaired What's Here sections for Range, String, Symbol, Struct #5735

merged 2 commits into from Mar 30, 2022

Conversation

BurdetteLamar
Copy link
Member

Compliance with documentation_guide.rdoc.

@BurdetteLamar BurdetteLamar added the Documentation Improvements to documentation. label Mar 30, 2022
Copy link
Contributor

@jeremyevans jeremyevans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple sections with indentation issues. After those issues are fixed, can be committed directly. Please perform a visual review of the pages generated by rdoc to check that all indentations are correct before committing.

string.c Outdated
* - #encoding: Returns the Encoding object that represents the encoding of the string.
* - #unicode_normalized?: Returns +true+ if the string is in Unicode normalized form; +false+ otherwise.
* - #valid_encoding?: Returns +true+ if the string contains only characters that are valid
* for its encoding.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line needs to be indented correctly.

string.c Outdated
* removing duplicates from the substrings that were modified.
* - #%:: Returns the string resulting from formatting a given object into +self+
* - #dump: Returns a copy of +self with all non-printing characters replaced by \xHH notation
* and all special characters escaped.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This and other lines in this section need to be indented correctly.

@BurdetteLamar BurdetteLamar merged commit ffcdbed into ruby:master Mar 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements to documentation.
2 participants