Fix readme in RBC project#648
Merged
pancetta merged 5 commits intoParallel-in-Time:masterfrom May 5, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR corrects reStructuredText formatting in the Rayleigh-Benard project README so the documentation renders command examples and the simulation list correctly.
Changes:
- Added the required blank lines after
.. code-block:: bashdirectives. - Fixed the “Plotting microscopic verification” list formatting so the bullet list is parsed correctly.
- Kept the documented commands and workflow unchanged while repairing the README syntax.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Turns out the syntax is incorrect in the current version. This PR adds a bunch of empty lines in order to fix the syntax.