Enhance README.rst code block readability#786
Merged
Pierre-Sassoulas merged 1 commit intoprospector-dev:masterfrom Aug 3, 2025
Merged
Enhance README.rst code block readability#786Pierre-Sassoulas merged 1 commit intoprospector-dev:masterfrom
Pierre-Sassoulas merged 1 commit intoprospector-dev:masterfrom
Conversation
Using code block syntax highlighting to improve readability.
Pierre-Sassoulas
approved these changes
Aug 3, 2025
Collaborator
Pierre-Sassoulas
left a comment
There was a problem hiding this comment.
Thank you, nice catch !
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.
Summary from GitHub Copilot:
Description
Using code block syntax highlighting to improve readability.
Motivation and Context
Improve README.rst code block readability by using explicit reStructuredText code blocks (e.g.,
.. code-block:: yaml) instead of::for clearer, correctly highlighted examples.How Has This Been Tested?
Review the rendered README in rich-diff and see the result.
Types of changes
Checklist: