Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for how the _object_links method should be used in extensions #191

Closed
lossyrob opened this issue Oct 9, 2020 · 1 comment
Closed
Labels
documentation Issues related to PySTAC documentation

Comments

@lossyrob
Copy link
Member

lossyrob commented Oct 9, 2020

The _object_links method is important for extensions that provide new links to other STAC objects. This allows PySTAC to know what links point to other STAC objects for things like fully resolving a catalog into an in-memory structure.

Currently that method has little documentation around it, so new extension authors won't know to implement that method appropriately. The goal of this issue is to add docs such that someone implementing an extension would be able to successfully implement that method for any extension that adds links to a STAC object.

@lossyrob lossyrob added the documentation Issues related to PySTAC documentation label Oct 9, 2020
@lossyrob
Copy link
Member Author

lossyrob commented May 4, 2021

Closing as _object_links for extensions is going away with #309 and the new way of doing this (ExtensionHooks) should be documented as part of other issues.

@lossyrob lossyrob closed this as completed May 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues related to PySTAC documentation
Projects
None yet
Development

No branches or pull requests

1 participant