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.

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

Harmonize commitish and committish in docstrings #799

Merged
merged 1 commit into from Feb 7, 2022
Merged

Harmonize commitish and committish in docstrings #799

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/repo.rs
View file
Open in desktop
Expand Up @@ -811,7 +811,7 @@ impl Repository {

/// Make the repository HEAD directly point to the commit.
///
/// If the provided committish cannot be found in the repository, the HEAD
/// If the provided commitish cannot be found in the repository, the HEAD
/// is unaltered and an error is returned.
///
/// If the provided commitish cannot be peeled into a commit, the HEAD is
Expand All @@ -831,7 +831,7 @@ impl Repository {

/// Make the repository HEAD directly point to the commit.
///
/// If the provided committish cannot be found in the repository, the HEAD
/// If the provided commitish cannot be found in the repository, the HEAD
/// is unaltered and an error is returned.
/// If the provided commitish cannot be peeled into a commit, the HEAD is
Comment on lines -834 to 836
Copy link
Contributor Author

Choose a reason for hiding this comment

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

e.g. here we have both spellings directly one after another - so maybe it makes sense to harmonize it? Or does it not make any sense because it we might get both variants back anyway?

/// unaltered and an error is returned.
Expand Down
10 changes: 5 additions & 5 deletions src/revwalk.rs
View file
Open in desktop
Expand Up @@ -81,7 +81,7 @@ impl<'repo> Revwalk<'repo> {

/// Mark a commit to start traversal from.
///
/// The given OID must belong to a committish on the walked repository.
/// The given OID must belong to a commitish on the walked repository.
///
/// The given commit will be used as one of the roots when starting the
/// revision walk. At least one commit must be pushed onto the walker before
Expand Down Expand Up @@ -111,7 +111,7 @@ impl<'repo> Revwalk<'repo> {
/// A leading 'refs/' is implied if not present as well as a trailing `/ \
/// *` if the glob lacks '?', ' \ *' or '['.
///
/// Any references matching this glob which do not point to a committish
/// Any references matching this glob which do not point to a commitish
/// will be ignored.
pub fn push_glob(&mut self, glob: &str) -> Result<(), Error> {
let glob = CString::new(glob)?;
Expand All @@ -136,7 +136,7 @@ impl<'repo> Revwalk<'repo> {

/// Push the OID pointed to by a reference
///
/// The reference must point to a committish.
/// The reference must point to a commitish.
pub fn push_ref(&mut self, reference: &str) -> Result<(), Error> {
let reference = CString::new(reference)?;
unsafe {
Expand Down Expand Up @@ -194,7 +194,7 @@ impl<'repo> Revwalk<'repo> {
/// A leading 'refs/' is implied if not present as well as a trailing `/ \
/// *` if the glob lacks '?', ' \ *' or '['.
///
/// Any references matching this glob which do not point to a committish
/// Any references matching this glob which do not point to a commitish
/// will be ignored.
pub fn hide_glob(&mut self, glob: &str) -> Result<(), Error> {
let glob = CString::new(glob)?;
Expand All @@ -206,7 +206,7 @@ impl<'repo> Revwalk<'repo> {

/// Hide the OID pointed to by a reference.
///
/// The reference must point to a committish.
/// The reference must point to a commitish.
pub fn hide_ref(&mut self, reference: &str) -> Result<(), Error> {
let reference = CString::new(reference)?;
unsafe {
Expand Down