Skip to content

Commit

Permalink
Fix the documentation so that it looks sane in Vim too
Browse files Browse the repository at this point in the history
  • Loading branch information
davidburstrom committed Jan 1, 2023
1 parent abf5466 commit 18fd936
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ For the folders below in monospace text, they are published on maven central at
| `lib-extra` | Contains the optional parts of Spotless which require external dependencies. `LineEnding.GIT_ATTRIBUTES` won't work unless `lib-extra` is available. |
| `plugin-gradle` | Integrates spotless and all of its formatters into Gradle. |
| `plugin-maven` | Integrates spotless and all of its formatters into Maven. |
| _ext | Folder for generating glue jars (specifically packaging Eclipse jars from p2 for consumption using maven).
| `_ext` | Folder for generating glue jars (specifically packaging Eclipse jars from p2 for consumption using maven).

## How to add a new FormatterStep

Expand Down Expand Up @@ -119,7 +119,7 @@ There are many great formatters (prettier, clang-format, black, etc.) which live

Because of Spotless' up-to-date checking and [git ratcheting](https://github.com/diffplug/spotless/tree/main/plugin-gradle#ratchet), Spotless actually doesn't have to call formatters very often, so even an expensive shell call for every single invocation isn't that bad. Anything that works is better than nothing, and we can always speed things up later if it feels too slow (but it probably won't).

## How to enable the _ext projects
## How to enable the `_ext` projects

The `_ext` projects are disabled per default, since:

Expand Down

0 comments on commit 18fd936

Please sign in to comment.