Skip to content

Commit

Permalink
Add some more information to the readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
fredrikekre committed Aug 12, 2024
1 parent 4bee1e0 commit 73ab2ae
Showing 1 changed file with 40 additions and 22 deletions.
62 changes: 40 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ This is a list of things that Runic currently is doing:
- [Parentheses around operator calls in colon](#parentheses-around-operator-calls-in-colon)
- [`in` instead of `∈` and `=`](#in-instead-of--and-)
- [Braces around right hand side of `where`](#braces-around-right-hand-side-of-where)
- [Trailing whitespace](#trailing-whitespace)
- [Whitespace miscellaneous](#whitespace-miscellaneous)
### Line width limit
Expand Down Expand Up @@ -345,26 +345,6 @@ x = a + b *
d
```
### Vertical spacing
Runic removes empty vertical spacing so that there are at maximum two empty lines between
expressions. Examples:
```diff
-function f()
- x = 1
-
-
-
- return x
-end
+function f()
+ x = 1
+
+
+ return x
+end
```
### Spaces around operators, assignment, etc
Runic formats spaces around infix operators, assignments, comparison chains, and type
Expand Down Expand Up @@ -598,10 +578,48 @@ Braces are consistently used around the right hand side of `where` expressions.
+T where {T <: S} where {S <: Any}
```
### Trailing whitespace
### Whitespace miscellaneous
#### Trailing spaces
Trailing spaces are removed. Example:
```diff
-1 + 1
+1 + 1
```
#### Tabs
Tabs are replaced with spaces. Example:
```diff
-function f()
- return 1
-end
+function f()
+ return 1
+end
```
#### Vertical spacing
Extra vertical spacing is trimmed so that there are at maximum two empty lines
between expressions. Examples:
```diff
-function f()
- x = 1
-
-
-
- return x
-end
+function f()
+ x = 1
+
+
+ return x
+end
```
Any newlines at the start of a file are removed and if the file ends with more
than one newline the extra ones are removed.

0 comments on commit 73ab2ae

Please sign in to comment.