Apply suggestions from code review

Co-authored-by: David Hewitt <[email protected]>
Co-authored-by: Georg Brandl <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -21,7 +21,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Add `Py::setattr` method. [#2009](https://github.com/PyO3/pyo3/pull/2009)
 - Add `PyCapsule`, exposing the [Capsule API](https://docs.python.org/3/c-api/capsule.html#capsules). [#1980](https://github.com/PyO3/pyo3/pull/1980)
-- `#[pyclass]` now supports fieldless enums. It also provide default implementation for `__repr__`, `__int__`, and `__richcmp__` for enums.
+- Enable `#[pyclass]` for fieldless (aka C-like) enums. [#2034](https://github.com/PyO3/pyo3/pull/2034)
 
 ### Changed
 

guide/src/class.md

@@ -20,7 +20,7 @@ This chapter will discuss the functionality and configuration these attributes o
 
 ## Defining a new class
 
-To define a custom Python class, add `#[pyclass]` attribute to a Rust struct or a fieldless enum.
+To define a custom Python class, add the `#[pyclass]` attribute to a Rust struct or a fieldless enum.
 ```rust
 # #![allow(dead_code)]
 # use pyo3::prelude::*;
@@ -33,7 +33,7 @@ struct MyClass {
 #[pyclass]
 enum MyEnum {
     Variant,
-    OtherVariant = 30, // support custom discriminant.
+    OtherVariant = 30, // PyO3 supports custom discriminants.
 }
 ```
 
@@ -144,8 +144,8 @@ so that they can benefit from a freelist. `XXX` is a number of items for the fre
 * `gc` - Classes with the `gc` parameter participate in Python garbage collection.
 If a custom class contains references to other Python objects that can be collected, the [`PyGCProtocol`]({{#PYO3_DOCS_URL}}/pyo3/class/gc/trait.PyGCProtocol.html) trait has to be implemented.
 * `weakref` - Adds support for Python weak references.
-* `extends=BaseType` - Use a custom base class. The base `BaseType` must implement `PyTypeInfo`. Enums can't have custom base class.
-* `subclass` - Allows Python classes to inherit from this class. Enums cannot be inherited.
+* `extends=BaseType` - Use a custom base class. The base `BaseType` must implement `PyTypeInfo`. `enum` pyclasses can't use a custom base class.
+* `subclass` - Allows Python classes to inherit from this class. `enum` pyclasses can't be inherited from.
 * `dict` - Adds `__dict__` support, so that the instances of this type have a dictionary containing arbitrary instance variables.
 * `unsendable` - Making it safe to expose `!Send` structs to Python, where all object can be accessed
    by multiple threads. A class marked with `unsendable` panics when accessed by another thread.

pyo3-macros-backend/src/pyclass.rs

@@ -383,9 +383,8 @@ struct PyClassEnumVariant<'a> {
 
 struct PyClassEnum<'a> {
     ident: &'a syn::Ident,
-    // The underyling representation of the enum.
-    // It's used to implement __int__ and __richcmp__.
-    // This matters when the underyling representation may not fit in `isize`.
+    // The underlying #[repr] of the enum, used to implement __int__ and __richcmp__.
+    // This matters when the underlying representation may not fit in `isize`.
     repr: syn::Ident,
     variants: Vec<PyClassEnumVariant<'a>>,
     doc: PythonDoc,