ulekarsiddhant0-boop opened a new pull request, #3525:
URL: https://github.com/apache/fory/pull/3525

   ## Why?
   
   The Python documentation guides (`basic-serialization.md` and 
`custom-serializers.md`) currently have inconsistent or missing syntax 
highlighting tags. This leads to:
   1. Poor readability for developers following the guides.
   2. Potential rendering issues in the Sphinx/Hugo documentation build 
pipeline.
   3. Inconsistent user experience across the Apache Fury™ site.
   
   ## What does this PR do?
   
   This PR resolves #1344 by performing the following documentation clean-up:
   - **Language Tagging:** Standardized all code blocks in the Python guide to 
use the correct `python` identifier.
   - **Formatting Fixes:** Corrected spacing and indentation in 
`basic-serialization.md` to ensure code snippets are valid and copy-paste 
friendly.
   - **API Readability:** Improved the layout of the Buffer API and Custom 
Serializer examples in `custom-serializers.md` for better visual clarity.
   - **Structural Integrity:** Ensured blank lines are properly placed between 
text and code blocks to satisfy Markdown parser requirements.
   
   ## Related issues
   
   - Fixes #1344
   
   ## AI Contribution Checklist
   
   - [x] Substantial AI assistance was used in this PR: `yes`
   - [x] I included a completed AI Contribution Checklist in this PR 
description and the required AI Usage Disclosure.
   
   ## Does this PR introduce any user-facing change?
   
   - [ ] Does this PR introduce any public API change?
   - [ ] Does this PR introduce any binary protocol compatibility change?
   *(This PR is documentation-only and contains no logic changes.)*
   
   ## Benchmark
   *(Not applicable for documentation fixes.)*
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to