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

Add markdown blocks to explain each code block #13

Open
franz825 opened this issue Oct 7, 2020 · 2 comments · May be fixed by #30
Open

Add markdown blocks to explain each code block #13

franz825 opened this issue Oct 7, 2020 · 2 comments · May be fixed by #30
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@franz825
Copy link

franz825 commented Oct 7, 2020

For didactic purposes, it would be great to add markdown blocks above each code block of both upland and fluvial components. It would contain a description of the goal of each block.

@josiearcuri josiearcuri added the documentation Improvements or additions to documentation label Oct 7, 2020
@edsaac edsaac self-assigned this Oct 7, 2020
@edsaac
Copy link
Contributor

edsaac commented Oct 8, 2020

Started a new branch (/markdownDocumentation) for this issue.

I've been adding explanations to blocks of code in fluvial_group.ipynb and making the plots a tad prettier.

@edsaac edsaac linked a pull request Oct 14, 2020 that will close this issue
@edsaac edsaac removed a link to a pull request Oct 14, 2020
@josiearcuri
Copy link
Contributor

Duplicate of #27

@josiearcuri josiearcuri marked this as a duplicate of #27 Jan 3, 2021
@josiearcuri josiearcuri linked a pull request Jan 9, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants