-
-
Notifications
You must be signed in to change notification settings - Fork 33.2k
Closed
Labels
3.11only security fixesonly security fixesdocsDocumentation in the Doc dirDocumentation in the Doc dir
Description
As discovered in #98295 , there are several undocumented new APIs in the enum module:
ReprEnumand is documented in What's New (and exported in__all__), but not anywhere in the enum library module documentation, which seems like an oversight.- Likewise,
global_enumis documented in What's New (and exported in__all__) and was previously documented in the library docs, but that documentation was reverted in bpo-40066: Revert "Revert "bpo-40066: [Enum] update str() and format() output..." #30637 , and not restored, so I'm unsure on the current status. global_str,global_enum_reprandglobal_flag_reprwere added (to replace the__str__()and__repr__()of the appropriate classes) and are not marked as private (_) and are exported by__all__, but aren't documented either. Should they be?show_flag_valueswas added and is not in__all__, but its use is referred to in an error message (cited in the docs) and it is not marked private (_). Should this be documented as well?
@ethanfurman your guidance here would be much appreciated, thanks. I'm happy to review/copyedit a PR, or if you prefer, I can draft something and you review it. Ideally, we should get this in before the 3.11 release in a week or so...
Related: #95913
Linked PRs
Metadata
Metadata
Assignees
Labels
3.11only security fixesonly security fixesdocsDocumentation in the Doc dirDocumentation in the Doc dir