Skip to content

Update docs #11

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 1 commit into from
Oct 26, 2019
Merged

Update docs #11

merged 1 commit into from
Oct 26, 2019

Conversation

zverok
Copy link
Contributor

@zverok zverok commented Oct 26, 2019

  • Fix syntax in code examples for proper highlight
  • Add documentation for Matrix#combine
  • Other small fixes.

marcandre
marcandre reviewed Oct 26, 2019
View reviewed changes
Copy link
Member

@marcandre marcandre left a comment

Choose a reason for hiding this comment

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

Great job! Just one indent that seems wrong

lib/matrix.rb
# Matrix[ [1,2], [3,4] ].each(:strict_lower).to_a # => [3]
# Matrix[ [1,2], [3,4] ].each { |e| puts e }
# # => prints the numbers 1 to 4
# Matrix[ [1,2], [3,4] ].each(:strict_lower).to_a # => [3]
Copy link
Member

Choose a reason for hiding this comment

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

Why change the indent here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Otherwise, RDoc thinks the first line is the continuation of the list (same indent): https://docs.ruby-lang.org/en/master/Matrix.html#method-i-each
image

@marcandre marcandre merged commit 8a06d91 into ruby:master Oct 26, 2019
@marcandre
Copy link
Member

Very well, thanks for this 👍👍

@zverok zverok deleted the fix-docs branch October 26, 2019 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marcandre marcandre marcandre left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@zverok @marcandre