Skip to content

docs: add more plots to example1, fix typos, add links to API - #178

Merged
tobiasdiez merged 2 commits into
mainfrom
doc-fixes
Jul 27, 2026
Merged

docs: add more plots to example1, fix typos, add links to API#178
tobiasdiez merged 2 commits into
mainfrom
doc-fixes

Conversation

@tobiasdiez

Copy link
Copy Markdown
Contributor

Purpose of this PR

Just a few minor improvements to the docs that I encountered while learning about flodym

  • Add a few plots to example1 and fix a few typos in there
  • Add links to the flodym concepts from the overview page.

Checklist:

  • I have used the Conventional Commits format for my PR title (and commit messages)
  • I have updated the in-code documentation of all changed classes and functions
  • I have added in-code documentation and type hints to all new classes and functions
  • I have adapted the howtos
  • I have adapted the examples

@JakobBD JakobBD left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Awesome, thanks!

The documentation could use a lot more links.
Maybe something for an AI agent?

@tobiasdiez
tobiasdiez merged commit c3bb0c9 into main Jul 27, 2026
11 checks passed
@tobiasdiez
tobiasdiez deleted the doc-fixes branch July 27, 2026 19:21
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