Skip to content

Commit a94ba6f

Browse files
authored
Update README.md
1 parent a5f1463 commit a94ba6f

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@
44
[![codecov](https://codecov.io/gh/Tortar/HybridStructs.jl/graph/badge.svg?token=F8W0MC53Z0)](https://codecov.io/gh/Tortar/HybridStructs.jl)
55

66
This package provides a simple way to create both mutable and immutable versions
7-
of a struct from a single definition. This can be particularly useful when you want to switch between
8-
mutable and immutable implementations without adding redundant code to define each version.
7+
of a struct from a single definition. This can be particularly useful when you want
8+
to switch between mutable and immutable implementations without adding redundant code
9+
to define each version.
910

1011
## Usage
1112

@@ -29,10 +30,10 @@ It is then possible to create instances of the specified version:
2930

3031
```julia
3132
julia> s1 = S(1, 2, 3.0; mutable=true)
32-
S_Mut{Int}(1, 2, 3)
33+
S_Mut{Int}(1, 2, 3.0)
3334

3435
julia> s2 = S(1, 2, 3.0; mutable=false)
35-
S_Immut{Int}(1, 2.0, 3)
36+
S_Immut{Int}(1, 2.0, 3.0)
3637
```
3738

3839
For ease of use it is also possible to use a macro to mutate both versions
@@ -57,4 +58,4 @@ Importantly, there are some catches to keep in mind:
5758

5859
## Contributing
5960

60-
Contributions to HybridStructs.jl are welcome! Please feel free to submit issues, pull requests, or suggestions to improve the package.
61+
Contributions are welcome! Please feel free to submit issues, pull requests, or suggestions to improve the package.

0 commit comments

Comments
 (0)