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.

Sign up for GitHub

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

Jump to bottom

[REVIEW] Add complete (if basic) usage example to docs homepage and README #32

Closed
ashiklom opened this issue Apr 17, 2023 · 2 comments
Closed

[REVIEW] Add complete (if basic) usage example to docs homepage and README #32

ashiklom opened this issue Apr 17, 2023 · 2 comments

Comments

@ashiklom
Copy link

ashiklom commented Apr 17, 2023 •
edited
Loading

I suggest including 1-2 examples of complete usage on the README and documentation home page. Basically, what you've already done in PlantBiophysics.jl.

For another good example, see SpeedyWeather.jl.

openjournals/joss-reviews#5371
@ashiklom ashiklom mentioned this issue Apr 17, 2023
Closed
VEZY added a commit that referenced this issue Apr 24, 2023
@VEZY
Working on #32
121dc58
VEZY added a commit that referenced this issue Apr 25, 2023
@VEZY
Add examples to docs landing page regarding #32
8c631dd
VEZY referenced this issue Apr 25, 2023
@VEZY
Fix computation for fitting Beer + update tests
839a19c
@VEZY
Copy link
Member

VEZY commented Apr 25, 2023

Hey @ashiklom, thanks for the review. I added two basic examples to the README + the landing page of the doc. Is this what you expected ? If not, let me know I'll be happy to improve it further.

PS: the docs in SpeedyWeather.jl are down (very nice package btw, I would love to use it at some point!).

@VEZY VEZY closed this as completed Apr 27, 2023
@ashiklom
Copy link
Author

Looks great, nice work! I agree that this has been addressed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ashiklom @VEZY