Document package design choices #719
Conversation
docs/src/philosophy.md
Outdated
| Due to the way that the julia ecosystem has evolved, | ||
| this means that `Interval` **must** be a subtype of `Real`, | ||
| as it is the default supertype used to describe | ||
| "numbers that are not complex". |
There was a problem hiding this comment.
Maybe "must" is too strong?
"
Due to the evolution of the Julia ecosystem -- specifically that Real serves as the default supertype for numerical types that are not complex --, it is particularly advantageous for Interval to be defined as a subtype of Real.
"
There was a problem hiding this comment.
I have tuned it down a little bit, but I like "must" so that it is clear it is not open for discussion (at least for the current document).
| This has a clear cost, however, in that some expected behaviors do not hold. | ||
| For example, an `Interval` is not equal to itself. |
There was a problem hiding this comment.
Maybe this can be removed. What you wrote above, seems already very clear.
There was a problem hiding this comment.
I think it doesn't hurt to have an example.
|
|
||
| ## Intervals as sets | ||
|
|
||
| We have taken the perspective to always let `Interval`s act as if they were numbers. |
There was a problem hiding this comment.
If we want to avoid the word "number":
"
We have taken the perspective to always let Intervals behave as numerical values.
"
|
Thanks @Kolaru for the PR. It looks really good. Closes #647. Maybe due to #675, we can add a sentence (near where EDIT: also, maybe we could add the documentation for |
|
I've added a summary of the behaviors, I think it address your concerns. I have also added I can add the doc for I am a bit worried, as the documentation here does not match the behavior on master. Should I port the change from #698 for consistency ? |
As discussed last Friday, I have drafted an addition to the documentation to discuss some design choices that we have made.
I have summarized all discussion that I could think of for now, but please let me know if any other controversies should be mentionned to.