Skip to content

Commit

Permalink
Fix typo in documentation: _normal -> normal
Browse files Browse the repository at this point in the history
Signed-off-by: Steve Peters <[email protected]>
  • Loading branch information
scpeters committed Apr 14, 2022
1 parent 42335fa commit 5015a7e
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion include/sdf/Plane.hh
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ namespace sdf
/// \return The plane normal vector.
public: ignition::math::Vector3d Normal() const;

/// \brief Set the plane normal vector. The _normal vector will be
/// \brief Set the plane normal vector. The normal vector will be
/// normalized. See ignition::math::Vector3d Normal() for more information
/// about the normal vector, such as the frame in which it is specified.
/// \param[in] _normal The plane normal vector.
Expand Down
2 changes: 1 addition & 1 deletion python/src/sdf/pyPlane.cc
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ void definePlane(pybind11::object module)
"for a Visual or Collision object, then the normal is specified in "
"the Visual or Collision frame, respectively.")
.def("set_normal", &sdf::Plane::SetNormal,
"Set the plane normal vector. The _normal vector will be "
"Set the plane normal vector. The normal vector will be "
"normalized. See ignition::math::Vector3d Normal() for more "
"information about the normal vector, such as the frame in which it "
"is specified.")
Expand Down

0 comments on commit 5015a7e

Please sign in to comment.