git-for-windows/git
1
0
Fork 0
mirror of https://github.com/git-for-windows/git.git synced 2026-04-19 19:39:56 -05:00
Code Issues Packages Projects Releases 335 Wiki Activity

doc: document autocorrect API

Browse Source 
Explain behaviors for autocorrect_resolve(), autocorrect_confirm(), and
struct autocorrect.

Signed-off-by: Jiamu Sun <39@barroit.sh>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Jiamu Sun
2026-03-17 00:36:23 +09:00
committed by Junio C Hamano
parent 273faabea8
commit 916b450805
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
autocorrect.h
View File

@@ -9,13 +9,24 @@ enum autocorrect_mode {
AUTOCORRECT_DELAY,
};
/**
* `mode` indicates which action will be performed by autocorrect_confirm().
* `delay` is the timeout before autocorrect_confirm() returns, in tenths of a
* second. Use it only with AUTOCORRECT_DELAY.
*/
struct autocorrect {
enum autocorrect_mode mode;
int delay;
};
/**
* Resolve the autocorrect configuration into `conf`.
*/
void autocorrect_resolve(struct autocorrect *conf);
/**
* Interact with the user in different ways depending on `conf->mode`.
*/
void autocorrect_confirm(struct autocorrect *conf, const char *assumed);
#endif /* AUTOCORRECT_H */