Skip to content

Make naming on README more consistent #326

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
Nov 8, 2017
Merged

Make naming on README more consistent #326

merged 1 commit into from
Nov 8, 2017

Conversation

aeroastro
Copy link
Contributor

I would like to make naming more consistent and understandable especially on README so that new developers can easily get familiar with rubyzip.

IMHO, I would like to rename variables on README in the following way.

  • io => zipfile
    • First example uses zipfile and it is an object of Zip::File
    • Since Zip::File uses IO-like objects in some cases, this change could reduce some confusion.
  • os => f
    • Second example uses f and it is an object of Tempfile

Any better ideas are welcome.

@coveralls
Copy link

coveralls commented Apr 17, 2017 •
edited
Loading

Coverage Status

Coverage remained the same at 91.384% when pulling 99dc241 on aeroastro:feature/readme-improvement into 98f4f2e on rubyzip:master.

@aeroastro aeroastro force-pushed the feature/readme-improvement branch from 99dc241 to 1ea4656 Compare August 7, 2017 10:54
@aeroastro aeroastro force-pushed the feature/readme-improvement branch from 1ea4656 to 3c0de6c Compare August 7, 2017 10:58
@aeroastro
Copy link
Contributor Author

I have resolved conflict.

@coveralls
Copy link

coveralls commented Aug 7, 2017 •
edited
Loading

Coverage Status

Coverage remained the same at 91.535% when pulling 1ea4656 on aeroastro:feature/readme-improvement into fc83680 on rubyzip:master.

@coveralls
Copy link

coveralls commented Aug 7, 2017 •
edited
Loading

Coverage Status

Coverage remained the same at 91.535% when pulling 3c0de6c on aeroastro:feature/readme-improvement into fc83680 on rubyzip:master.

@simonoff simonoff merged commit 4ecb5b9 into rubyzip:master Nov 8, 2017
@aeroastro aeroastro deleted the feature/readme-improvement branch November 8, 2017 19:10
@aeroastro
Copy link
Contributor Author

Thank you very much!!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@aeroastro @coveralls @simonoff