Skip to content

Rename Worktree class to WorkingTree#24

Merged
jcouball merged 1 commit intomainfrom
rename_worktree
Oct 19, 2020
Merged

Rename Worktree class to WorkingTree#24
jcouball merged 1 commit intomainfrom
rename_worktree

Conversation

@jcouball
Copy link
Member

@jcouball jcouball commented Oct 17, 2020

Description

Rename the Worktree class to WorkingTree to be more consistent with Git documentation and the term's use in public.

See the definition of Working Tree in the Git glossary or search the web for Git working tree.

What is changed?

All code and documentation that referred to worktree was changed to working tree.

What else was changed and why?

  • Updated the description of the RubyGit module in the project's README.md and in lib/ruby_git.rb
  • Added the SVG version of the RubyGit Class Diagram so people don't have to look at it in LucidChart

@jcouball jcouball requested a review from a team as a code owner October 17, 2020 17:01
@jcouball jcouball force-pushed the rename_worktree branch 3 times, most recently from b165dfd to 532f80d Compare October 17, 2020 23:15
lib/ruby_git.rb Outdated
end

# Create an empty Git repository under the root worktree `path`
# Create an empty Git repository under the root woring tree `path`

Choose a reason for hiding this comment

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

Spelling error.

README.md Outdated
RubyGit is an object-oriented wrapper for the `git` command line tool for working with Worktrees
and Repositories. It tries to make more sense out of the Git command line. See the object model
in [this Lucid chart diagram](https://app.lucidchart.com/invitations/accept/7df13bab-3383-4683-8cb4-e76d539de93d)
RubyGit is an object-oriented wrapper for the `git` command line tool for working git Repositories.

Choose a reason for hiding this comment

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

Perhaps you want to add 'with' here? ...working WITH git repositories. (Up to you...)

@jcouball jcouball force-pushed the rename_worktree branch 2 times, most recently from db7abac to 3460f37 Compare October 18, 2020 21:45
@jcouball
Copy link
Member Author

Thanks, @frankthrock for the review. I have fixed the issues you pointed out and added the following:

  • Updated the description of the RubyGit module in the README.md
  • Updated the description of the RubyGit module in the documentation in lib/ruby_git.rb
  • Added the SVG for the RubyGit class diagram so people don't have to view it in Lucid Charts. I updated the link in the README.md to point to this SVG instead of the Lucid Charts version.

Copy link

@frankthrock frankthrock left a comment

Choose a reason for hiding this comment

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

Looks really good. I like the verbose changes.

@jcouball jcouball merged commit 6c8fd7a into main Oct 19, 2020
@jcouball jcouball deleted the rename_worktree branch October 19, 2020 19:07
@jcouball jcouball mentioned this pull request Mar 28, 2025
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