Skip to content

Commit ff67de3

Browse files
authored
Update docstring of name argument to Classification.apply to agree with extension specification (#1356)
* Update docstring of name argument to agree with extension specification (#1355) * Update changelog with #1356
1 parent db7531d commit ff67de3

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
### Changed
66

77
- 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))
8+
- 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))
89

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

pystac/extensions/classification.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,8 @@ def apply(
6868
Args:
6969
value: The integer value corresponding to this class
7070
description: The description of this class
71-
name: The optional human-readable short name for this class
71+
name: Short name of the class for machine readability. Must consist only
72+
of letters, numbers, -, and _ characters.
7273
color_hint: An optional hexadecimal string-encoded representation of the
7374
RGB color that is suggested to represent this class (six hexadecimal
7475
characters, all capitalized)
@@ -103,7 +104,8 @@ def create(
103104
104105
Args:
105106
value: The integer value corresponding to this class
106-
name: The human-readable short name for this class
107+
name: Short name of the class for machine readability. Must consist only
108+
of letters, numbers, -, and _ characters.
107109
description: The optional long-form description of this class
108110
color_hint: An optional hexadecimal string-encoded representation of the
109111
RGB color that is suggested to represent this class (six hexadecimal

0 commit comments

Comments
 (0)