move SerializationContext to asdf.extension and add it to docs #1573
Conversation
This file contains 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
braingram
commented
Jun 27, 2023
braingram
changed the title
braingram
force-pushed
the
docs/sctx
branch
2 times, most recently
from
abfcc82 to
1646cd2
Compare
5 tasks
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.
As far as I can tell, the public usage of SerializationContext occurs exclusively through extensions.
Rather than document
asdf.asdf(whereSerializationContextwas implemented prior to this PR) which was previously undocumented, this PR movesSerializationContexttoasdf.extension._serialization_contextand exposes it publicly atasdf.extension.SerializationContext.Code that imports
SerializationContextfromasdf.asdfshould continue to work (asSerializationContextis imported inasdf.asdf) but should be updated to import from the documented public location once this PR makes it into a release.Link to relevant updated docs: https://asdf--1573.org.readthedocs.build/en/1573/api/asdf.extension.SerializationContext.html#asdf.extension.SerializationContext
Fixes #1565
Fixes #1549