Skip to content

Commit

Permalink
Better documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
mitiguy committed Oct 3, 2024
1 parent f4c5832 commit c96ebff
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions multibody/tree/geometry_spatial_inertia.h
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,8 @@ SpatialInertia<double> CalcSpatialInertia(const geometry::Shape& shape,
- All triangles must be "wound" such that their normals point outward
(according to the right-hand rule based on vertex winding).
In the rare situation that we can detect when these requirements are not met,
an exception is thrown and no value is returned. Otherwise, the returned
SpatialInertia is meaningless.
In the rare situation that we detect unmet requirements, an exception is thrown
(no value is returned). Otherwise, the returned SpatialInertia is meaningless.
@throws std::exception if the volume of `mesh` is negative or nearly zero.
@pydrake_mkdoc_identifier{mesh} */
SpatialInertia<double> CalcSpatialInertia(
Expand Down

0 comments on commit c96ebff

Please sign in to comment.