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.

Sign up for GitHub

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

Update docstring of name argument to Classification.apply to agree with extension specification #1356

Merged
merged 2 commits into from
Jul 1, 2024
Merged

Update docstring of name argument to Classification.apply to agree with extension specification #1356

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c42324
Update docstring of name argument to agree with extension specificati…
bmcandr Jun 25, 2024
26a5c53
Update changelog with #1356
bmcandr Jun 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
### Changed

- Allow object ID as input for getting APILayoutStrategy hrefs and add `items`, `collections`, `search`, `conformance`, `service_desc` and `service_doc` href methods. ([#1335](https://github.com/stac-utils/pystac/pull/1335))
- Update docstring of `name` argument to `Classification.apply` and `Classification.create` to agree with extension specification. ([#1356](https://github.com/stac-utils/pystac/pull/1356))

## [v1.10.1] - 2024-05-03

Expand Down
6 changes: 4 additions & 2 deletions pystac/extensions/classification.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,8 @@ def apply(
Args:
value: The integer value corresponding to this class
description: The description of this class
name: The optional human-readable short name for this class
name: Short name of the class for machine readability. Must consist only
of letters, numbers, -, and _ characters.
color_hint: An optional hexadecimal string-encoded representation of the
RGB color that is suggested to represent this class (six hexadecimal
characters, all capitalized)
Expand Down Expand Up @@ -103,7 +104,8 @@ def create(

Args:
value: The integer value corresponding to this class
name: The human-readable short name for this class
name: Short name of the class for machine readability. Must consist only
of letters, numbers, -, and _ characters.
description: The optional long-form description of this class
color_hint: An optional hexadecimal string-encoded representation of the
RGB color that is suggested to represent this class (six hexadecimal
Expand Down