Skip to content

Enhance README.rst code block readability#786

Merged
Pierre-Sassoulas merged 1 commit intoprospector-dev:masterfrom
PeterDaveHello:README.rst
Aug 3, 2025
Merged

Enhance README.rst code block readability#786
Pierre-Sassoulas merged 1 commit intoprospector-dev:masterfrom
PeterDaveHello:README.rst

Conversation

@PeterDaveHello
Copy link
Copy Markdown
Contributor

Summary from GitHub Copilot:

This pull request updates the README.rst file to improve the clarity and formatting of code examples related to configuring pre-commit hooks for Prospector. The changes replace inline code examples with properly formatted yaml code blocks using the .. code-block:: yaml directive.

Documentation Improvements:

  • Updated the pre-commit configuration examples to use .. code-block:: yaml for better readability and consistency in README.rst. [1] [2] [3] [4]

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • My change requires a change to the dependencies
  • I have updated the dependencies accordingly
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Using code block syntax highlighting to improve readability.
Copy link
Copy Markdown
Collaborator

@Pierre-Sassoulas Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

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

Thank you, nice catch !

@Pierre-Sassoulas Pierre-Sassoulas merged commit d7092f5 into prospector-dev:master Aug 3, 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