Skip to content

Commit daf7a6f

Browse files
committed
Correct descriptions of applyStash: and popStash:
1 parent 00a5bc4 commit daf7a6f

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

ObjectiveGit/GTRepository+Stashing.h

+4-4
Original file line numberDiff line numberDiff line change
@@ -62,22 +62,22 @@ NS_ASSUME_NONNULL_BEGIN
6262
/// will cause enumeration to stop after the block returns. Must not be nil.
6363
- (void)enumerateStashesUsingBlock:(void (^)(NSUInteger index, NSString * __nullable message, GTOID * __nullable oid, BOOL *stop))block;
6464

65-
/// Apply stashed changes (with a default checkout strategy).
65+
/// Apply stashed changes.
6666
///
6767
/// index - The index of the stash to apply. 0 is the latest one.
6868
/// flags - The flags to use when applying the stash.
69-
/// options - The options to use when checking out.
69+
/// options - The options to use when checking out (if nil, use the defaults provided by libgit2).
7070
/// error - If not NULL, set to any error that occurred.
7171
/// progressBlock - A block that will be executed on each step of the stash application.
7272
///
7373
/// Returns YES if the requested stash was successfully applied, NO otherwise.
7474
- (BOOL)applyStashAtIndex:(NSUInteger)index flags:(GTRepositoryStashApplyFlag)flags checkoutOptions:(nullable GTCheckoutOptions *)options error:(NSError **)error progressBlock:(nullable void (^)(GTRepositoryStashApplyProgress progress, BOOL *stop))progressBlock;
7575

76-
/// Pop stashed changes (with a default checkout strategy).
76+
/// Pop stashed changes.
7777
///
7878
/// index - The index of the stash to apply. 0 is the most recent stash.
7979
/// flags - The flags to use when applying the stash.
80-
/// options - The options to use when checking out.
80+
/// options - The options to use when checking out (if nil, use the defaults provided by libgit2).
8181
/// error - If not NULL, set to any error that occurred.
8282
/// progressBlock - A block that will be executed on each step of the stash application.
8383
///

0 commit comments

Comments
 (0)