Skip to content

Commit

Permalink
Mention Runic in changelog and contributing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fredrikekre committed Oct 31, 2024
1 parent 774078c commit 2b47c00
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased

### Other
* Documenter now uses [Runic.jl](https://github.com/fredrikekre/Runic.jl) for code formatting.

## Version [v1.7.0] - 2024-09-04

### Added
Expand Down
10 changes: 3 additions & 7 deletions docs/src/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,20 +30,16 @@ Follow the style of the surrounding text when making changes. When adding new fe

### Julia

* 4-space indentation;
* modules spanning entire files should not be indented, but modules that have surrounding code should;
* no blank lines at the start or end of files;
* do not manually align syntax such as `=` or `::` over adjacent lines;
Documenter uses [Runic.jl](https://github.com/fredrikekre/Runic.jl) for code
formatting. In addition, the following style guidelines should be followed:

* use `function ... end` when a method definition contains more than one toplevel expression;
* related short-form method definitions don't need a new line between them;
* unrelated or long-form method definitions must have a blank line separating each one;
* surround all binary operators with whitespace except for `::`, `^`, and `:`;
* files containing a single `module ... end` must be named after the module;
* method arguments should be ordered based on the amount of usage within the method body;
* methods extended from other modules must follow their inherited argument order, not the above rule;
* explicit `return` should be preferred except in short-form method definitions;
* avoid dense expressions where possible e.g. prefer nested `if`s over complex nested `?`s;
* include a trailing `,` in vectors, tuples, or method calls that span several lines;
* do not use multiline comments (`#=` and `=#`);
* wrap long lines as near to 92 characters as possible, this includes docstrings;
* follow the standard naming conventions used in `Base`.
Expand Down

0 comments on commit 2b47c00

Please sign in to comment.