Skip to content

Rdoc #15

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 8 commits into from
Apr 10, 2021
Merged

Rdoc #15

merged 8 commits into from
Apr 10, 2021

Conversation

BurdetteLamar
Copy link
Member

These commits:

  • Resolve shared use of mixed_names.rb.
  • Add long option with negation.
  • Include --help for all examples.
  • Add table of contents for tutorial.
  • Move doc for argument converters to separate rdoc file.

@BurdetteLamar BurdetteLamar added the documentation Improvements or additions to documentation label Apr 9, 2021
olleolleolle
olleolleolle approved these changes Apr 9, 2021
View reviewed changes
Copy link
Contributor

@olleolleolle olleolleolle left a comment

Choose a reason for hiding this comment

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

Very helpful to have the full descriptive help text for each of the options.

ToC seems helpful, for an overview of what's there.

Also, file renames seemed 👍

@nobu
Copy link
Member

nobu commented Apr 10, 2021

Links should be relative to the rdocs, instead of external HTMLs.

@BurdetteLamar BurdetteLamar removed the request for review from nobu April 10, 2021 13:35
@BurdetteLamar
Copy link
Member Author

Links should be relative to the rdocs, instead of external HTMLs.

@nobu, I have changed the explicit links to auto-links.

@BurdetteLamar BurdetteLamar merged commit c91ed8d into ruby:master Apr 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@olleolleolle olleolleolle olleolleolle approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@BurdetteLamar @nobu @olleolleolle