/// 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.
Current documentation says this:
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