Ferrite-FEM / Ferrite-FEM/Ferrite.jl
Decide if example should be written with global variables etc or with functions
Open
docs
- Dominant language
- Julia
- Stars
- 453
- Forks
- 115
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 11
Description
Some examples and tutorial have the style of:
```julia
a = ...
b = ...
function do_something(a, b)
....
end
c = do_something(a,b)
```
Others have something like
```julia
function do_something(a, b)
....
end
function main()
a =
b =
c = do_something(a, b)
end
```
The first way is a bit easier to write "prose style" of documentation for but the second style is more "julian" and might perform slightly better. It's also a little bit arbitrary in the first style which parts should be in global scope and which should be in local.
Would be good to be consistent I guess.
Contributor guide
Assessment
This issue has not been assessed yet.