Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

propose_docs_example #96

Merged
merged 1 commit into from
Feb 27, 2021
Merged

propose_docs_example #96

merged 1 commit into from
Feb 27, 2021

Conversation

rafaqz
Copy link
Member

@rafaqz rafaqz commented Feb 18, 2021

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
Copy link
Contributor

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
Copy link
Member Author

rafaqz commented Feb 18, 2021

Can you approve it then? ;)

@virgile-baudrot
Copy link
Contributor

of course

@rafaqz
Copy link
Member Author

rafaqz commented Feb 18, 2021

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

@rafaqz rafaqz merged commit 2912bfe into master Feb 27, 2021
@rafaqz rafaqz deleted the docs_examples branch February 27, 2021 10:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants