Skip to content

Add porting guide for users coming from orjson - #995

Closed
Siyet wants to merge 2 commits into
msgspec:mainfrom
Siyet:642-orjson-porting-guide
Closed

Siyet wants to merge 2 commits into
msgspec:mainfrom
Siyet:642-orjson-porting-guide

Conversation

@Siyet

@Siyet Siyet commented Mar 31, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Add docs/porting-from-orjson.rst covering API mapping, option equivalents, typed decoding, error handling, and features without direct equivalent
  • Add page to toctree in docs/index.rst under "Advanced" section

Closes #642

Test plan

  • Sphinx build produces no warnings from the new file
  • All RST cross-references (:doc:, :func:) resolve correctly
  • CI passes

Cover API mapping, option equivalents, typed decoding, error handling,
and features without direct equivalent.

Closes #642
@Siyet

Siyet commented Apr 1, 2026

Copy link
Copy Markdown
Contributor Author

"build" (documentation) - link checker fails on a pre-existing broken link (#976)

@Siyet

Siyet commented Apr 8, 2026

Copy link
Copy Markdown
Contributor Author

Resolved in the community fork msgspec-arise: PR #11, released in v0.20.2.

@ofek ofek left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks! Could you add a dedicated section for porting so that we can add more pages within, such as one for Pydantic?

@Siyet Siyet closed this by deleting the head repository Apr 9, 2026
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.

Porting guide for users coming from orjson

2 participants