[prev in list] [next in list] [prev in thread] [next in thread] 

List:       orocos-dev
Subject:    [Orocos-Dev] [Bug 57] New: Documentation error in Rotation class
From:       orocos-bugzilla () fmtc ! be (orocos-bugzilla () fmtc ! be)
Date:       2006-05-04 11:21:22
Message-ID: bug-57-4 () http ! www ! fmtc ! be/orocos-bugzilla/
[Download RAW message or body]

For more information about this bug, visit
     <http://www.fmtc.be/orocos-bugzilla/show_bug.cgi?id=57>

A new bug was added:
           Summary: Documentation error in Rotation class
           Product: Orocos
           Version: orocos-trunk
          Platform: All
        OS/Version: All
            Status: NEW
          Severity: normal
          Priority: P2
         Component: Kinematics
        AssignedTo: orocos-dev@lists.mech.kuleuven.be
        ReportedBy: johan.rutgeerts@mech.kuleuven.be


The documentation of Rotation::RPY said: 

"Sets the value of this object to a rotation specified with [...]"

This is incorrect, as the function does not change the *this object.

I changed it to:

"Gives back a rotation matrix specified with [...]",

similar to the documentation of Rotation::EulerZYX and Rotation::EulerZYZ.


I committed this on trunk (don't know if I'm supposed to have done that, but
it's only documentation and I'm sure it was wrong).


Maybe it would be good to also have e.g. setRPY() and setEulerZYX() methods,
similar to the getRPY() and getEulerZYX() methods already present.


-- 
(this mail is best viewed with a fixed font)
Configure bugmail: http://www.fmtc.be/orocos-bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are on the CC list for the bug, or are watching someone who is.

[prev in list] [next in list] [prev in thread] [next in thread]