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

Why so many vignettes? #4

Closed
florianhartig opened this issue Apr 5, 2020 · 4 comments
Closed

Why so many vignettes? #4

florianhartig opened this issue Apr 5, 2020 · 4 comments

Comments

@florianhartig
Copy link
Member

@ohagen - is there are special reason why we wouldn't put everything in the same vignette?

@ohagen
Copy link
Member

ohagen commented Apr 6, 2020

The idea is to have an introduction vignette very simple to make the user confortable with the main structure. Then one for creating landscapes and one for creating configs. Then, a few with diferente examples or in this case just a long one. No strong preference.

@florianhartig
Copy link
Member Author

hm ... I would imagine it's easier for the user to have a single long vignette. Short examples about how to use the functions are imo better in the function and package help

@ohagen
Copy link
Member

ohagen commented Apr 6, 2020

I see your point. The problem is that there are long complex examples for the landscapes creating case. With many conversions and use of other package functions before entering our package.

@ohagen
Copy link
Member

ohagen commented Apr 6, 2020

We can start like this now and see if we can make a nice long one at the end. Different people will work on different files now

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

No branches or pull requests

2 participants