Module-level documentation and 'Quick start' section. #95
Conversation
ismael-lajaaiti
force-pushed
the
improve_doc
branch
from
80d0dc4 to
434a8bf
Compare
|
Could this PR be merged (after rebasing it), as the last point of the TODO belong now to #107 (@iago-lito) ? |
ismael-lajaaiti
changed the title
ismael-lajaaiti
added
the
documentation
|
Wop! I had completely forgotten about these two commits. Sorry for that @ismael-lajaaiti, I'm having a look at them rn. |
|
Well, yes. I see no reason not to rebase this at least. Can you rebase and then maybe ask @Thomalpas for review? |
|
I have rebased the branch on top of |
|
Thanks for your review @Thomalpas, here are the changes requested. Let me know if now everything is good for you. |
ismael-lajaaiti
force-pushed
the
improve_doc
branch
from
434a8bf to
2f29441
Compare
|
Am happy thank you @ismael-lajaaiti |
ismael-lajaaiti
force-pushed
the
improve_doc
branch
from
2f29441 to
bc24914
Compare
There was a problem hiding this comment.
Hi @ismael-lajaaiti! This looks good to me, except that the tests are broken because you labeled ] add Package as julia code in the docs although it's not. Once this is fixed, you need to autoformat your files and we'll be good to go :)
Thank you @Thomalpas for having checked the English language here <3
docs/src/index.md
Outdated
|
|
||
| ## References | ||
| ```julia | ||
| ] add EcologicalNetworkDynamics |
There was a problem hiding this comment.
Wop! This is not exactly Julia code, it's another language corresponding to the "package mode" of Julia. This breaks autoformatting checks, because JuliaFormatter parses all ```julia chunks, considering they contain Julia code.
Maybe you can fix that by using ```julia-pkg instead?
There was a problem hiding this comment.
I'll go for the equivalent in the Julia language i.e.
using Pkg
Pkg.add("EcologicalNetworksDynamics")If it's good for you.
docs/src/index.md
Outdated
|
|
||
| ## How can I contribute? | ||
|
|
||
| The easiest way to contribute is to [open an issue](https://github.com/BecksLab/EcologicalNetworksDynamics.jl/issues) | ||
| The easiest way to contribute is to [open an issue](https://pkg-url/issues) |
There was a problem hiding this comment.
We know the package url now that #100 happened :) You can replace all these mock urls with https://github.com/BecksLab/EcologicalNetworksDynamics.jl/ now!
docs/src/man/foodwebs.md
Outdated
| @@ -126,7 +126,7 @@ You can pass any of those models, with the required arguments, to generate food | |||
| using EcologicalNetworks | |||
| S = 20 # species richness | |||
| C = 0.2 # connectance | |||
| foodweb = FoodWeb(nichemodel, S; C = C) | |||
| foodweb = FoodWeb(nichemodel, S; C, tol = 0.01) | |||
There was a problem hiding this comment.
Ay, leave a note somewhere on your desk to come back and update this once #115 is fixed ;)
|
|
||
| ```@example quickstart | ||
| using EcologicalNetworksDynamics, Plots | ||
| fw = FoodWeb([1 => 2, 2 => 3]) # 1 eats 2, and 2 eats 3 |
iago-lito
force-pushed
the
improve_doc
branch
2 times, most recently
from
ee5a6f1 to
b583965
Compare
docs/src/index.md
Outdated
|
|
||
| During your journey learning EcologicalNetworksDynamics you might encounter issues. | ||
| If so the best is to open an issue on the | ||
| [GitHub page of EcologicalNetworksDynamics](https://pkg-url/issues). |
There was a problem hiding this comment.
This url has not been updated X)
docs/src/index.md
Outdated
| !!! note "Todo" | ||
|
|
||
| Update url address if needed when the package is released. | ||
| The contribution guidelines are detailed [here](https://pkg-url/contributing.md). |
iago-lito
force-pushed
the
improve_doc
branch
from
b583965 to
66df8b1
Compare
Changes
use case for non-trophic interactions (optional: use case featuring EcologicalNetworkStability.jl) Add use cases to the documentation #90(now addressed by First use cases. #107)