Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Quaternion.fromHeadingPitchRoll documentation is incorrect #5264

Closed
shunter opened this issue May 1, 2017 · 3 comments
Closed

Quaternion.fromHeadingPitchRoll documentation is incorrect #5264

shunter opened this issue May 1, 2017 · 3 comments
Labels
category - doc good first issue An opportunity for first time contributors

Comments

@shunter
Copy link
Contributor

shunter commented May 1, 2017

The Quaternion.fromHeadingPitchRoll function does not document the headingOrHeadingPitchRoll parameter, specifically that it can be a HeadingPitchRoll (and also does not mention the deprecating of the individual HPR parameters).

Code was apparently added in #4896 but documentation was not correctly updated.

@pjcozzi pjcozzi added the good first issue An opportunity for first time contributors label May 3, 2017
@emackey
Copy link
Contributor

emackey commented May 22, 2017

The intermediate API has the first parameter as headingOrHeadingPitchRoll, but after the deprecated API is removed, presumably the name of the first parameter will then change to just headingPitchRoll.

Question, should the jsDoc parameter name match what's there right now, or match what the public API will become once the deprecated stuff is removed? I would think the latter, otherwise the doc would have to explain what the oddly-named pitchOrResult parameter is supposed to be.

@pjcozzi
Copy link
Contributor

pjcozzi commented May 22, 2017

I would think the latter...

Sounds good.

@emackey
Copy link
Contributor

emackey commented May 22, 2017

@klingerj use headingPitchRoll as a single parameter in place of the first three (heading, pitch, roll) and leave the existing [result] parameter doc untouched. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category - doc good first issue An opportunity for first time contributors
Projects
None yet
Development

No branches or pull requests

3 participants