[sean0407]

For reviewers

• I did not use AI
• I used AI and thoroughly reviewed every code/docs change

Summary

The 2.3.1 switch to StrEnum changed str(member) to return its value.

- str(ParameterKind.var_keyword) -> "ParameterKind.var_keyword"
+ str(ParameterKind.var_keyword) -> "variadic keyword"
+ ParameterKind.var_keyword.name -> "var_keyword"

Evidence

• Before: The 2.3.1 changelog mentions Python 3.10 support removal, and the ParameterKind API reference does not explain str().
• After: The changelog and API reference document that str(member) returns its value while .name returns the member name.
• Validation: git diff --check and a standard-library StrEnum behavior probe passed.

Description of the change

Users comparing or logging enum strings now have a release note and API reference describing the 2.3.1 behavior change.

Relevant resources

• docs: 2.3.1 made the public enums StrEnum, so str(ParameterKind.var_keyword) is now "variadic keyword"; a changelog line? #501

Merge Danger

Door: two-way

Blast Radius: documentation

Issue-501: #501

[pawamoy]

Thanks for the PR. Lets document that the string representation of enumeration values is not part of the public API. This can be written in packages/griffelib/src/griffe/__init__.py. We can note that the name and value attributes of enumeration values are public, and that their values are stable.

Then in the changelog, we can remove the "breaking changes" section and instead add a short sentence after <small>. Can you take care of this @sean0407 🙂?

[pawamoy]

Lets remove some of it. I'll apply the suggestions.

[pawamoy]

Thanks again!