docs: Add detailed Python Syntax documentation with examples and explanations#86
Merged
Merged
Conversation
…anations Co-Authored-By: Sanjay Viswanathan <[email protected]>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new Python Syntax documentation page, refines the Intro to Python section, and updates the Python category index description.
- Adds
docs/python/python-syntax.mdwith detailed Python syntax sections and examples - Updates
docs/python/intro-python.mdto include a “Why Python is So Popular” section and refines front-matter - Revises
docs/python/_category_.jsondescription to reflect Python content
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/python/python-syntax.md | New page covering Python syntax structure with examples |
| docs/python/intro-python.md | Updated description and added popularity section for Python |
| docs/python/category.json | Updated category index description to describe Python |
Comments suppressed due to low confidence (2)
docs/python/python-syntax.md:9
- [nitpick] The tag 'Introduction of python' uses a lowercase 'python' and the phrasing is unclear. Consider changing it to 'Introduction to Python' with proper capitalization.
Introduction of python,
docs/python/python-syntax.md:29
- The code block closing fence uses four backticks instead of three, which may break rendering. Replace the closing fence with ```.
</details>
sanjay-kv
approved these changes
Jun 7, 2025
sanjay-kv
left a comment
sanjay-kv
left a comment
Member
There was a problem hiding this comment.
This is good documentation.
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.
issues : #85
This PR adds a new documentation page titled "Python Syntax" The page provides a detailed overview of Python’s syntax structure with properly categorized sections and code examples for better understanding.
What’s Included
if,elif,else)for,while)Why This is Useful
This addition enhances the educational value of the Docusaurus site by serving as a beginner-friendly reference for Python learners. It fits well in the documentation section and follows consistent formatting.