Skip to content

Commit

Permalink
Updating Edge and Vertex docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
gumyr committed Feb 2, 2024
1 parent 081ef73 commit b44c404
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions src/build123d/topology.py
Original file line number Diff line number Diff line change
Expand Up @@ -4364,7 +4364,13 @@ def wires(self) -> list[Wire]:


class Edge(Mixin1D, Shape):
"""A trimmed curve that represents the border of a face"""
"""An Edge in build123d is a fundamental element in the topological data structure
representing a one-dimensional geometric entity within a 3D model. It encapsulates
information about a curve, which could be a line, arc, or other parametrically
defined shape. Edge is crucial in for precise modeling and manipulation of curves,
facilitating operations like filleting, chamfering, and Boolean operations. It
serves as a building block for constructing complex structures, such as wires
and faces."""

# pylint: disable=too-many-public-methods

Expand Down Expand Up @@ -6916,7 +6922,12 @@ def sweep_multi(


class Vertex(Shape):
"""A Single Point in Space"""
"""A Vertex in build123d represents a zero-dimensional point in the topological
data structure. It marks the endpoints of edges within a 3D model, defining precise
locations in space. Vertices play a crucial role in defining the geometry of objects
and the connectivity between edges, facilitating accurate representation and
manipulation of 3D shapes. They hold coordinate information and are essential
for constructing complex structures like wires, faces, and solids."""

_dim = 0

Expand Down

0 comments on commit b44c404

Please sign in to comment.