cesaraustralia / Dispersal.jl

Tools for simulating organism dispersal
Other
21 stars 3 forks source link

propose_docs_example #96

Closed rafaqz closed 3 years ago

rafaqz commented 3 years ago

Description

Having runnable examples for all rules would probably help new users a lot. It might require some thought to make it an interesting enough example that they learn something from it. e.g. AlleeExtinction is pretty boring on its own.

This PR updates the docs guidelines to enforce adding examples from now on. Which will also require updating all the existing rules.

virgile-baudrot commented 3 years ago

Yes. @jamesmaino asked me what would be the thing to do for field ecologist using R to come in Julia. I think a zoo of examples you can copy/paste and makes it working would be great

rafaqz commented 3 years ago

Can you approve it then? ;)

virgile-baudrot commented 3 years ago

of course

rafaqz commented 3 years ago

I mean click "approve" in the review :). Its actually locked until its approved by someone