Skip to content

Comments

README: Address reviewer comments.#61

Merged
Sbte merged 6 commits intoBIMAU:masterfrom
Sbte:pr/reviewer-comments
Sep 4, 2025
Merged

README: Address reviewer comments.#61
Sbte merged 6 commits intoBIMAU:masterfrom
Sbte:pr/reviewer-comments

Conversation

@Sbte
Copy link
Contributor

@Sbte Sbte commented Aug 11, 2025

For #57, #59.

@Sbte Sbte requested a review from dajuno August 11, 2025 18:56
Copy link
Collaborator

@dajuno dajuno left a comment

Choose a reason for hiding this comment

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

I like the changes.

Only examples/gq.py is referenced in the docs, all other examples are supposed to "speak for themselves". Wouldn't it make sense to reference them as example implementations in the problem definitions? Taylor-Couette and Rayleigh-Benard don't have examples, but I think all examples can be linked to a problem definition.

Or tell interested readers of the docs somewhere else what the purpose is of the different setups provided in examples (in docs/continuation.rst you only state that "examples are kept simple to give an idea").

This may be a bit pedantic, if you deem your changes sufficient I won't object!

@Sbte
Copy link
Contributor Author

Sbte commented Sep 4, 2025

Only examples/gq.py is referenced in the docs, all other examples are supposed to "speak for themselves". Wouldn't it make sense to reference them as example implementations in the problem definitions? Taylor-Couette and Rayleigh-Benard don't have examples, but I think all examples can be linked to a problem definition.

The idea was that all examples are useful for any problem definition. That's also why TC and RB don't have an example. I could add some but they'd be the same as existing examples, so they'd just be more things to distract you from more relevant examples.

Or tell interested readers of the docs somewhere else what the purpose is of the different setups provided in examples (in docs/continuation.rst you only state that "examples are kept simple to give an idea").

I'll add an examples page to the docs to reflect the above.

@Sbte Sbte force-pushed the pr/reviewer-comments branch from 1e03bfd to 58260bb Compare September 4, 2025 18:14
@Sbte Sbte force-pushed the pr/reviewer-comments branch from 58260bb to 78379de Compare September 4, 2025 18:16
@Sbte Sbte merged commit cbfcf17 into BIMAU:master Sep 4, 2025
7 checks passed
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