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

Deprecate asdf.testing.helpers.format_tag and asdf.versioning.AsdfSpec #1774

Merged
merged 4 commits into from
May 7, 2024

Conversation

braingram
Copy link
Contributor

@braingram braingram commented Mar 18, 2024

Description

This PR deprecates asdf.testing.helpers.format_tag (and replaces it's one use with a string) and asdf.versioning.AsdfSpec (which is unused).

Fixes: #1773

Checklist:

  • pre-commit checks ran successfully
  • tests ran successfully
  • for a public change, a changelog entry was added
  • for a public change, documentation was updated
  • for any new features, unit tests were added

@braingram braingram marked this pull request as ready for review March 18, 2024 17:58
@braingram braingram requested a review from a team as a code owner March 18, 2024 17:58
@braingram
Copy link
Contributor Author

The downstream dkist error is unrelated and looks to be caused by a gwcs version comparison in one of their tests.

@braingram braingram changed the title Deprecate format tag Deprecate asdf.testing.helpers.format_tag and asdf.versioning.AsdfSpec Mar 18, 2024
Copy link
Member

@zacharyburnett zacharyburnett left a comment

Choose a reason for hiding this comment

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

LGTM; is this in the docs anywhere? I see an auto-generated reference to format_tag but not explicitly creating a tag from a string

@braingram
Copy link
Contributor Author

Thanks!

The only docs I also see are the auto-generated ones:
https://asdf.readthedocs.io/en/latest/search.html?q=format_tag&check_keywords=yes&area=default

I don't quite know the whole history of format_tag but looking through various git blames:

  • was moved from asdf.types (when that was deprecated)
  • was moved from asdf.asdftypes (when that was deprecated)
  • was added in the first "skeleton" of the project

but never appears to be documented beyond the docstring and auto-generated docs. It seems to always have been a way to construct a uri string from several string (or AsdfVersion, when that was added) components.

@braingram braingram merged commit e72de8b into asdf-format:main May 7, 2024
48 checks passed
@braingram braingram deleted the deprecate_format_tag branch May 7, 2024 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

deprecate AsdfSpec and format_tag
2 participants