Skip to content

Commit

Permalink
Improve documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
mitiguy committed Oct 3, 2024
1 parent cb3a25a commit f4c5832
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion multibody/tree/geometry_spatial_inertia.h
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +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).
If these requirements are not met, an exception *may* be thrown or the returned
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.
@throws std::exception if the volume of `mesh` is negative or nearly zero.
@pydrake_mkdoc_identifier{mesh} */
Expand Down

0 comments on commit f4c5832

Please sign in to comment.