Skip to content

Add proper Python code fences for syntax highlighting in README examples #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Programmer-RD-AI opened this issue May 22, 2025 · 1 comment · Fixed by #31
Closed

Add proper Python code fences for syntax highlighting in README examples #29

Programmer-RD-AI opened this issue May 22, 2025 · 1 comment · Fixed by #31

Comments

@Programmer-RD-AI
Copy link

Programmer-RD-AI commented May 22, 2025

🐛 Problem

The Python examples in the README.md aren’t wrapped in triple backticks with the python language specifier. As a result:

  • There’s no syntax highlighting, making the examples harder to read.
  • Indentation and inline comments blend into the text, reducing clarity.

📋 Reproduction

  1. Navigate to the project’s README.
  2. Scroll to any of the “Python Examples” sections.
  3. Observe that the code is rendered as plain text without highlighting.

✅ Expected Behavior

  • All Python snippets should be fenced like so:

    ```python
    # Example code here
  • This will enable syntax highlighting on GitHub, improving readability.

💡 Proposed Solution

  1. Edit each code block in README.md to add ```python fences.
  2. Verify rendering on GitHub’s preview.
  3. Optionally, add a CI check or lint rule to ensure future examples include the correct fences.

📖 Additional Context

Improving syntax highlighting aligns with best practices for documentation and lowers the barrier for new contributors trying out the examples.

@abhijithneilabraham
Copy link
Collaborator

Thank you for the feedback. We'll integrate these changes.

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 a pull request may close this issue.

2 participants