Framework for Python

Git

git_hooks_uninstall()

Remove Framework's pre-commit hook. A hook Framework did not write is kept.

Usage

git_hooks_uninstall(
    settings_file: str | Path | None = None,
    *,
    verbose: bool = True,
) -> bool

Arguments

Name Type Default Description
settings_file str | Path | None None

The project's settings file, whose folder holds the repository. Default: the folder of the settings file found from the current directory, or the current directory when there is none.

verbose bool True

Print what was done.

Value

Whether a hook was removed.