Skip to content

docs: fix syntax highlighting for Python serialization guide #1344#3525

Closed
ulekarsiddhant0-boop wants to merge 2 commits intoapache:mainfrom
ulekarsiddhant0-boop:patch-1
Closed

docs: fix syntax highlighting for Python serialization guide #1344#3525
ulekarsiddhant0-boop wants to merge 2 commits intoapache:mainfrom
ulekarsiddhant0-boop:patch-1

Conversation

@ulekarsiddhant0-boop
Copy link
Copy Markdown

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

AI Contribution Checklist

  • Substantial AI assistance was used in this PR: yes
  • 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.)

Removed empty lines in the Python serialization guide.
@chaokunyang
Copy link
Copy Markdown
Collaborator

No code change in this pr

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.

Segmentation fault when creating Fury instance

2 participants