Add docs/src/examples/basics.md page
#134
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #134 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 2 2
Lines 173 173
=========================================
Hits 173 173 ☔ View full report in Codecov by Sentry. |
docs/src/examples/basics.md
Outdated
|
|
||
| The type parameter `T <: Real` in `Quaternion{T}` represents the type of real and imaginary parts of a quaternion. | ||
|
|
||
| ### Lipschitz quaternions |
There was a problem hiding this comment.
Most of these quaternion types are niche and probably not of interest to nearly all of our users. So perhaps it would be better to not include them in basics.md and instead put them in a docs page devoted to specialized quaternion types.
There was a problem hiding this comment.
I added type_parameter.md page.
| Note that `Base.Complex` has the same type parameter restriction, and [bicomplex numbers](https://en.wikipedia.org/wiki/Bicomplex_number) are not supported in Base. | ||
| See [issue#79](https://github.com/JuliaGeometry/Quaternions.jl/issues/79) for more discussion. | ||
|
|
||
| ## Compatibility with `Complex` |
There was a problem hiding this comment.
But this does feel like it belongs here.
| @@ -0,0 +1,141 @@ | |||
| # Basics | |||
|
|
|||
| ## Basic operations for quaternions | |||
There was a problem hiding this comment.
It feels like sign should be somewhere discussed here as the right approach for constructing a unit quaternion.
Co-authored-by: Seth Axen <[email protected]>
Co-authored-by: Seth Axen <[email protected]>
Co-authored-by: Seth Axen <[email protected]>
Co-authored-by: Seth Axen <[email protected]>
Co-authored-by: Seth Axen <[email protected]>
Co-authored-by: Seth Axen <[email protected]>
b189952
to
d47b036
Compare
fix #45, fix #127