Improve documentation for Quaternion.canonicalizedTransform
Open
documentation
- Dominant language
- Swift
- Stars
- 1.9k
- Forks
- 181
- Avg merge
- 2d 5h
- Merged PRs (30d)
- 6
Description
I'd like to make this more precise. If I wasn't concerned about jargon, I would say "the canonical representative of the equivalence class of quaternions representing the same 3d transformation."
_Originally posted by @stephentyrone in https://github.com/apple/swift-numerics/pull/124_
Contributor guide
Research direction
Locate the documentation for Quaternion.canonicalizedTransform and compare its current wording with the precision requested in the issue. Update the description to explain that it is the canonical representative of the equivalence class of quaternions representing the same 3D transformation, while keeping the terminology understandable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100