Skip to content

Commit ed16c2d

Browse files
authored
python/README.md: Use lazy numbering for ordered list (#606)
Use 1. for all items in the binding organization list to avoid rippling diffs when items are added or reordered. https://google.github.io/styleguide/docguide/style.html#use-lazy-numbering-for-long-lists
1 parent f23b44b commit ed16c2d

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

src/python/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -144,11 +144,11 @@ To add bindings for a new class:
144144
Use the following sections to organize functions within the bindings files and tests. Secondarily, follow the order in which functions are declared in the C++ headers.
145145

146146
1. **Constructors** - Default constructors and constructors with parameters
147-
2. **Factory methods** - Static factory methods (e.g., `from_degrees`, `from_radians`, `zero`, `invalid`)
148-
3. **Properties** - Mutable and read-only properties (e.g., coordinate accessors like `x`, `y`, `lo`, `hi`)
149-
4. **Predicates** - Simple boolean state checks (e.g., `is_empty`, `is_valid`, `is_full`)
150-
5. **Geometric operations** - All other methods including conversions, computations, containment checks, set operations, normalization, and distance calculations
151-
6. **Vector operations** - Methods from the Vector base class (e.g., `norm`, `norm2`, `normalize`, `dot_prod`, `cross_prod`, `angle`). Only applicable to classes that inherit from `util/math/vector.h`
152-
7. **Operators** - Operator overloads (e.g., `==`, `+`, `*`, comparison operators)
153-
8. **String representation** - `__repr__` (which also provides `__str__`), and string conversion methods like `to_string_in_degrees`
154-
9. **Module-level functions** - Standalone functions (e.g., trigonometric functions for S1Angle)
147+
1. **Factory methods** - Static factory methods (e.g., `from_degrees`, `from_radians`, `zero`, `invalid`)
148+
1. **Properties** - Mutable and read-only properties (e.g., coordinate accessors like `x`, `y`, `lo`, `hi`)
149+
1. **Predicates** - Simple boolean state checks (e.g., `is_empty`, `is_valid`, `is_full`)
150+
1. **Geometric operations** - All other methods including conversions, computations, containment checks, set operations, normalization, and distance calculations
151+
1. **Vector operations** - Methods from the Vector base class (e.g., `norm`, `norm2`, `normalize`, `dot_prod`, `cross_prod`, `angle`). Only applicable to classes that inherit from `util/math/vector.h`
152+
1. **Operators** - Operator overloads (e.g., `==`, `+`, `*`, comparison operators)
153+
1. **String representation** - `__repr__` (which also provides `__str__`), and string conversion methods like `to_string_in_degrees`
154+
1. **Module-level functions** - Standalone functions (e.g., trigonometric functions for S1Angle)

0 commit comments

Comments
 (0)