Various documentation improvements. #265
Conversation
| The `Complex` type is generic over an associated `RealType`; complex numbers | ||
| are represented as two `RealType` values, the real and imaginary parts of the | ||
| number. | ||
| ``` |
There was a problem hiding this comment.
For broader compatibility with various Markdown viewer implementations, would it be possible to add an extra line before and after such code blocks?
| let a: Double = 1 | ||
| let b = 2*a |
There was a problem hiding this comment.
I think it is easier to follow along the arithmetic examples (especially the next one), if this unsupported heterogeneous operator example would re-use the example from C above (and below) – I may be wrong.
| let a: Double = 1 | |
| let b = 2*a | |
| import ComplexModule | |
| let r: Double = 1.0 | |
| let z = Complex<Double>(0, 2) | |
| let w = r + z // ❌ |
There was a problem hiding this comment.
The point is to provide an example that would break if we did have a heterogeneous operator.
There was a problem hiding this comment.
You are right - my example is misleading. Does it make sense to adjust the other two examples then, and make them use multiplication over addition?
There was a problem hiding this comment.
I tried to rearrange stuff to clarify it a little bit, might revisit later.
Added some docc catalogs and articles, fixed a bunch of minor errors, all that good stuff. More work needed.