Skip to content

doc: fix return value of open {} and use File.open {}#139

Merged
kou merged 2 commits intoruby:masterfrom
BurdetteLamar:rdoc
Jun 15, 2020
Merged

doc: fix return value of open {} and use File.open {}#139
kou merged 2 commits intoruby:masterfrom
BurdetteLamar:rdoc

Conversation

@BurdetteLamar
Copy link
Member

No description provided.

@BurdetteLamar BurdetteLamar requested a review from kou June 14, 2020 13:42
@BurdetteLamar
Copy link
Member Author

@kou, Something's terribly wrong here. The file doc/argument_io.rdoc is not here. I thought it was already merged, along with references to it. How to resolve?

@kou kou changed the title Enhanced RDoc for CSV doc: fix return value of open {} and use File.open {} Jun 14, 2020
Copy link
Member

@kou kou left a comment

Choose a reason for hiding this comment

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

I think that you just didn't commit doc/argument_io.rdoc.

Could you use more meaningful title for pull request title?
"Enhanced RDoc for CSV" is less meaningful:

  • Because this is the repository of CSV. "for CSV" is redundant. All changes are for CSV.
  • Because almost document changes are for enhancing document. "Enhanced RDoc" just means "Update document".

I've changed the title of this pull request. It'll help you for the next pull request.

FYI: If we use "... and ..." in the title, it indicates that the pull request includes multiple topics. We should focus on one topic per pull request. In this pull request case, we should create two pull requests, (1) fixing return value of open {} and (2) using File.open {}.

lib/csv.rb Outdated
# CSV.foreach(File.open(path)) {|row| p row } # => 21
# File.open(path) do |file|
# CSV.foreach(file) {|row| p row } # => 21
# end
Copy link
Member

Choose a reason for hiding this comment

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

Should we need to indent this code?

Copy link
Member Author

Choose a reason for hiding this comment

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

Done, thanks.

@BurdetteLamar BurdetteLamar requested a review from kou June 14, 2020 22:38
@kou kou merged commit 16b425e into ruby:master Jun 15, 2020
@BurdetteLamar BurdetteLamar deleted the rdoc branch June 15, 2020 18:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants