Update README.md #580
Merged
Update README.md #580
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jcouball
requested changes
May 14, 2022
README.md
Outdated
| @@ -108,7 +108,7 @@ g.index.writable? | |||
| g.repo | |||
| g.dir | |||
|
|
|||
| g.log # returns array of Git::Commit objects | |||
| g.log # returns Enumberator of Git::Commit objects | |||
There was a problem hiding this comment.
"Enumberator" is misspelled.
Maybe it would be better to say: "returns a Git::Log object which is an Enumerator of Git::Commit objects"
There was a problem hiding this comment.
I thought I had fixed the spelling error :(
Your suggestion is an improvement and should be used.
There was a problem hiding this comment.
If you agree with my suggestion, please redo this commit and I'll make sure it is reviewed and merged.
|
I appreciate the update! It looks great! Can you squash these commits into one commit? Here is how I would do it on your branch (should only take a few moments): This assumes that you don't have any other changes and you are on your PR branch: # Undo your two commits saving the changes in your work area
git reset HEAD~2
# Add the changes back, commit, and force push the result (with only one commit)
git add .
git commit -m 'Update README.md'
git push --force |
jcouball
approved these changes
May 16, 2022
|
I think the failed jruby-head build on windows-latest is caused by windows-latest being updated from Windows-2019 to Windows-2022. I will address it in a separate PR. |
p-mongo
pushed a commit
to p-mongodb/ruby-git
that referenced
this pull request
May 27, 2022
…' into mine * p/diff-submodule: (36 commits) Support --submodule option to git diff. Support the --all option for git fetch (ruby-git#583) Workaround to get JRuby build working (ruby-git#582) Update README.md (ruby-git#580) Make the directory param to Git.clone optional (ruby-git#578) Make Git::URL.clone_to handle cloning to bare and mirror repos (ruby-git#577) Add Git::URL #parse and #clone_to methods (ruby-git#575) Use the head version of yard (ruby-git#573) Release v1.11.0 Supress unneeded test output (ruby-git#570) Add support for fetch options "--force/-f" and "--prune-tags/-P". (ruby-git#563) Fix bug when grepping lines that contain numbers surrounded by colons (ruby-git#566) remove from maintainer (ruby-git#567) Address command line injection in Git::Lib#fetch Release v1.10.2 (ruby-git#561) Add create-release, setup, and console dev scripts (ruby-git#560) Store tempfile objects to prevent deletion during tests (ruby-git#555) Release v1.10.1 (ruby-git#553) Properly escape double quotes in shell commands on Windows (ruby-git#552) Properly unescape diff paths (ruby-git#504) ... * p/set-url-push: (36 commits) Add :push option to remote_set_url. Support the --all option for git fetch (ruby-git#583) Workaround to get JRuby build working (ruby-git#582) Update README.md (ruby-git#580) Make the directory param to Git.clone optional (ruby-git#578) Make Git::URL.clone_to handle cloning to bare and mirror repos (ruby-git#577) Add Git::URL #parse and #clone_to methods (ruby-git#575) Use the head version of yard (ruby-git#573) Release v1.11.0 Supress unneeded test output (ruby-git#570) Add support for fetch options "--force/-f" and "--prune-tags/-P". (ruby-git#563) Fix bug when grepping lines that contain numbers surrounded by colons (ruby-git#566) remove from maintainer (ruby-git#567) Address command line injection in Git::Lib#fetch Release v1.10.2 (ruby-git#561) Add create-release, setup, and console dev scripts (ruby-git#560) Store tempfile objects to prevent deletion during tests (ruby-git#555) Release v1.10.1 (ruby-git#553) Properly escape double quotes in shell commands on Windows (ruby-git#552) Properly unescape diff paths (ruby-git#504) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Corrected docs. No array is returned, instead, an enumerator is returned.