Skip to content
This repository has been archived by the owner on Mar 1, 2023. It is now read-only.

Commit

Permalink
remove .dev/format.jl
Browse files Browse the repository at this point in the history
  • Loading branch information
simonbyrne committed May 11, 2020
1 parent 75c5b08 commit c7e60a9
Show file tree
Hide file tree
Showing 4 changed files with 2 additions and 27 deletions.
18 changes: 0 additions & 18 deletions .dev/format.jl

This file was deleted.

2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ A clear and concise description of the code with usage.
I have

- [ ] Written and run all necessary tests with CLIMA by including `tests/runtests.jl`
- [ ] Followed all necessary [style guidelines](https://CliMA.github.io/CLIMA/latest/CodingConventions.html) and run `julia .dev/format.jl`
- [ ] Followed all necessary [style guidelines](https://CliMA.github.io/CLIMA/latest/CodingConventions.html) and run `julia .dev/climaformat.jl .`
- [ ] Updated the documentation to reflect changes from this PR.

<!--- Please leave the following section --->
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/JuliaFormatter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
version: 1.3
- name: Apply JuliaFormatter
run: |
julia --project=.dev .dev/format.jl origin/master
julia --project=.dev .dev/climaformat.jl .
- name: Check formatting diff
run: |
git diff --color=always --exit-code
7 changes: 0 additions & 7 deletions docs/src/HowToGuides/Contributing/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,13 +70,6 @@ For the most part, we follow the [YASGuide](https://github.com/jrevels/YASGuide)

In addition to this, once you are happy with your PR, please apply [JuliaFormatter.jl](https://github.com/domluna/JuliaFormatter.jl) to all changed files in the repository.

To apply our formatter settings to all changed files, run:
```
julia .dev/format.jl
```

Formatting changes should be done as a separate commit, ideally the last commit of the pull request (you may want to leave it until all other changes have been approved).

### Formatting utility

A convenience utility is located at `.dev/climaformat.jl` that will format the julia files in the given path. For example, from the top-level ClimateMachine directory
Expand Down

0 comments on commit c7e60a9

Please sign in to comment.