dimforge / dimforge/nalgebra

Automatically generated doc is not correct

Open
#477 1 comment 0 reactions 0 assignees View on GitHub
documentation P-medium
Dominant language
Rust
Stars
4.8k
Forks
565
PR merge metrics
No merged PRs in 30d

Description

In some points, there is some documentation generated automatically by some macro, that is not perfectly correct. A human should be able to see the meaning, but it can generate confusion at a first reading.
See for example https://nalgebra.org/rustdoc/nalgebra/base/struct.Matrix.html#method.sub_to. The doc says that the operation is equal to `self + rhs` while in fact it should perform `self - rhs`.

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.