Skip to content

Commit

Permalink
Add ExplicitImports and Chairmarks (#93)
Browse files Browse the repository at this point in the history
  • Loading branch information
gdalle committed Mar 20, 2024
1 parent aa48ec3 commit ca3f160
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
1 change: 1 addition & 0 deletions optimizing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ title = "Optimizing your code"

* [ProgressMeter.jl](https://github.com/timholy/ProgressMeter.jl)
* [BenchmarkTools.jl](https://github.com/JuliaCI/BenchmarkTools.jl)
* [Chairmarks.jl](https://github.com/LilithHafner/Chairmarks.jl)
* [TimerOutputs.jl](https://github.com/KristofferC/TimerOutputs.jl)

## Benchmark suites
Expand Down
3 changes: 3 additions & 0 deletions sharing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,9 @@ JET.test_package(MyAwesomePackage)

Note that both Aqua.jl and JET.jl might pick up false positives: refer to their respective documentations for ways to make them less sensitive.

Finally, [ExplicitImports.jl](https://github.com/ericphanson/ExplicitImports.jl) can help you get rid of generic imports to specify where each of the names in your package comes from.
This is a good practice and makes your code more robust to name conflicts between dependencies.

## Documentation

Even if your code does everything it is supposed to, it will be useless to others (and pretty soon to yourself) without proper documentation.
Expand Down

0 comments on commit ca3f160

Please sign in to comment.