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

Run quick start in docs #1811

Merged
merged 20 commits into from
Sep 19, 2024
Merged

Run quick start in docs #1811

merged 20 commits into from
Sep 19, 2024

Conversation

visr
Copy link
Member

@visr visr commented Sep 9, 2024

Fixes #1807.

Rather than having docs with code that doesn't run and output in static images, this intends to run the notebook as part of the docs generation just like example.ipynb.

I am also making more edits which I'll describe later.

@visr visr marked this pull request as ready for review September 19, 2024 14:19
@visr visr requested a review from SouthEndMusic September 19, 2024 14:19
Copy link
Collaborator

@SouthEndMusic SouthEndMusic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good

potential_evaporation | Float64 | $\text{m}/\text{s}$ | non-negative
drainage | Float64 | $\text{m}^3/\text{s}$ | non-negative
infiltration | Float64 | $\text{m}^3/\text{s}$ | non-negative
precipitation | Float64 | $\text m}/\text{s}$ | non-negative
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This removes the opening braces.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reverted the commit, and fixed in 3c86334.
I tried find and replace with regex in VS Code, but couldn't find any matches, probably since the notebooks are JSON encoded. Though if I then searched for the JSON encoding in VS Code that was also buggy, so I did it in trusty Notepad++

@visr visr merged commit cae6838 into main Sep 19, 2024
24 of 27 checks passed
@visr visr deleted the quick branch September 19, 2024 21:07
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.

Quickstart contains a number of typos
2 participants