Skip to content
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.

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

Consider replacing "commit" with "changeset" & reserve "commit" for the action #5

Open
waylan opened this issue Jul 7, 2009 · 1 comment

Comments

@waylan
Copy link

waylan commented Jul 7, 2009

I realize you get to paint the bikeshed as you built it, but at least give this some consideration.

It appears you are currently using git terminology. Now obviously you have to use something, but as was recently pointed out 1 by someone new to git (on the gitpython mailing list): "commit" is an action, yet the "commit" method refers to a previous commit object. Perhaps "changeset" (as used by Mercurial and others) would be a better term so that "commit" can be reserved for the action of creating a new commit if that feature is ever added to pyvcs.

Now, I realize pyvcs is described as "lightweight", so creating comits may be beyond its scope, but with multiple backends supported by default, there shouldn't be any reason to be married to the terminology of any one specific backend. Rather, the terminology used should be clear to anyone familiar to any one of the supported backends.

@alex
Copy link
Owner

alex commented Jul 7, 2009

It's true that we use the commit name, but we don't have a method named commit() or anything, the method names are get_commit_by_id and get_recent_commits. I don't think either of those would conflict with a commit() (the action) method.

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

No branches or pull requests

2 participants