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

Docstrings for Classification.apply and Classification.create describe name argument as human-readable name, but spec defines it as a machine-readable name #1355

Closed
bmcandr opened this issue Jun 24, 2024 · 0 comments · Fixed by #1356
Labels
documentation Issues related to PySTAC documentation

Comments

@bmcandr
Copy link
Contributor

bmcandr commented Jun 24, 2024

vs:

name: The human-readable short name for this class


Version 2.0.0 of the spec includes a breaking change to introduce a regex criteria to the name field to more explicitly define "machine-readable" as "Must consist only of letters, numbers, -, and _ characters." (e.g., ^[0-9A-Za-z-_]+$).

@gadomski gadomski added the documentation Issues related to PySTAC documentation label Jun 25, 2024
github-merge-queue bot pushed a commit that referenced this issue Jul 1, 2024
…e with extension specification (#1356)

* Update docstring of name argument to agree with extension specification (#1355)

* Update changelog with #1356
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
2 participants