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.

Sign up for GitHub

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

Jump to bottom

To fix nbformat pre-commit instructions... #2234

Closed
wants to merge 1 commit into from
Closed

To fix nbformat pre-commit instructions... #2234

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions tools/tensorflow_docs/tools/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,16 @@ this, use a standard Git hook or use the
[https://pre-commit.com/](https://pre-commit.com/) framework to create the hook
for you.

If you want to use pre-commit to handle the hook installation for you, include
the [.pre-commit-hooks.yaml](./.pre-commit-hooks.yaml) file in your repo with
the following contents:
If you want to use pre-commit to handle the hook installation for you, create a
`.pre-commit-config.yaml` file with the contents below to include the `nbformat`
hook from the [.pre-commit-hooks.yaml](./.pre-commit-hooks.yaml) plugin.

```
repos:
- repo: https://github.com/tensorflow/docs
rev: pre-commit
rev: 2023.5.24.56664
hooks:
- id: nbformat
```

Someone who clones that repo for development would then install the hook with:
Expand Down