dimforge / dimforge/nalgebra

Clarify angle units in the documentation

Open
#1,234 2 comments 0 reactions 0 assignees View on GitHub
documentation good first issue
Dominant language
Rust
Stars
4.8k
Forks
565
PR merge metrics
No merged PRs in 30d

Description

Some of the functions refer to angles, but they don't specify that these angels are to be expressed in radians. I think it'd be helpful to add it to the documentation. I've noticed it on [`Rotation::from_euler_angles()`](https://docs.rs/nalgebra/latest/nalgebra/geometry/struct.Rotation.html#method.from_euler_angles) and [`Rotation::euler_angles()`](https://docs.rs/nalgebra/latest/nalgebra/geometry/struct.Rotation.html#method.euler_angles) but [a quick search](https://docs.rs/nalgebra/latest/nalgebra/all.html?search=angle) showed other cases.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.