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

Documentation for update_index should be tweaked #967

Open
PoignardAzur opened this issue Jul 20, 2023 · 0 comments
Open

Documentation for update_index should be tweaked #967

PoignardAzur opened this issue Jul 20, 2023 · 0 comments

Comments

@PoignardAzur
Copy link

Current documentation says this:

/// Prevents checkout from writing the updated files' information to the
/// index.
///
/// Defaults to true.
pub fn update_index(&mut self, update: bool) -> &mut CheckoutBuilder<'cb>;

It's not completely clear when reading this whether setting this flag to true enables writing to the index or inhibits it (though the function and param names point towards the correct interpretation).

A better doc comment might be

When set to false, prevents checkout from writing the updated files' information to the index.

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

1 participant