Skip to content

Commit

Permalink
Order hooks alphabetically in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mondeja committed Jun 22, 2021
1 parent 75faa83 commit e3b9749
Showing 1 changed file with 22 additions and 22 deletions.
44 changes: 22 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,15 @@

## Hooks

### **`wavelint`**
### **`add-pre-commit-hook`**

Check if your WAVE files have the correct number of channels, frame rate,
durations...
Add a pre-commit hook to your configuration file if is not already defined.

#### Parameters

- `-nchannels=N` (*int*): Number of channels that your sounds must have.
- `-sample-width=N` (*int*): Number of bytes that your sounds must have.
- `-frame-rate=N` (*int*): Sampling frequency that your sounds must have.
- `-nframes=N` (*int*): Exact number of frames that your sounds must have.
- `-comptype=TYPE` (*str*): Compression type that your sounds must have.
- `-compname=NAME` (*int*): Compression that your sounds must have.
- `-min-duration=TIME` (*float*): Minimum duration in seconds that your
sounds must have.
- `-max-duration=TIME` (*float*): Maximum duration in seconds that your
sounds must have.
- `-repo=URL` (*str*) Repository of the new hook.
- `-rev=VERSION` (*str*) Version of the new hook.
- `-hook=ID` (*str*) Identifier of the new hook.

### **`dev-extras-required`**

Expand Down Expand Up @@ -61,20 +53,28 @@ requirement to another groups, it will be added to development requirements.
mandatory if the extras requirements are defined in a `pyproject.toml` file
and this is located in another directory than the current one.

### **`add-pre-commit-hook`**
### **`root-editorconfig-required`**

Add a pre-commit hook to your configuration file if is not already defined.
Check if your repository has an `.editorconfig` file and if this has a `root`
directive defined as `true` before section headers.

#### Parameters
### **`wavelint`**

- `-repo=URL` (*str*) Repository of the new hook.
- `-rev=VERSION` (*str*) Version of the new hook.
- `-hook=ID` (*str*) Identifier of the new hook.
Check if your WAVE files have the correct number of channels, frame rate,
durations...

### **`root-editorconfig-required`**
#### Parameters

Check if your repository has an `.editorconfig` file and if this has a `root`
directive defined as `true` before section headers.
- `-nchannels=N` (*int*): Number of channels that your sounds must have.
- `-sample-width=N` (*int*): Number of bytes that your sounds must have.
- `-frame-rate=N` (*int*): Sampling frequency that your sounds must have.
- `-nframes=N` (*int*): Exact number of frames that your sounds must have.
- `-comptype=TYPE` (*str*): Compression type that your sounds must have.
- `-compname=NAME` (*int*): Compression that your sounds must have.
- `-min-duration=TIME` (*float*): Minimum duration in seconds that your
sounds must have.
- `-max-duration=TIME` (*float*): Maximum duration in seconds that your
sounds must have.

[pypi-link]: https://pypi.org/project/mondeja_pre_commit_hooks
[pypi-version-badge-link]: https://img.shields.io/pypi/v/mondeja_pre_commit_hooks
Expand Down

0 comments on commit e3b9749

Please sign in to comment.