-
Notifications
You must be signed in to change notification settings - Fork 6
Start of a Philosophical Rewrite for Version 1.0.0 #21
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
* Add DatasetAxis and Dataset tests * Fix values/2 bug + Add Plox docs and tests for points/2 and values/1 * Add XAxis and YAxis docs and tests * Update docs and tests for Dimensions, Box, and DataPoint * Update Axis Protocol and ColorAxis docs + Add ColorAxis tests * Remove old unused graph_ files and tests * Add LinearAxis docs and tests * Update Scale + Remove Protocol test files * Adds docs and tests for all Scales * Add DateTimeScale docs and tests * Explicitly document which fns raise errors * Add DateScale docs and tests * Move protocol fn docs into moduledocs for doctests and visibility --------- Co-authored-by: Chris Dosé <chris@xn--dos-dma.com>
01c55c6 to
fa122b3
Compare
| def deps do | ||
| [ | ||
| {:plox, "~> 0.1.0"} | ||
| {:plox, "~> 0.2.0"} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We'll change this later to 1.0.0 ✨ when this rewrite is ready! 🤩 (not ready yet)
| @@ -0,0 +1,112 @@ | |||
| # Plox Migration Guide (0.2.0 to X.X.X) | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Leaving this generic for now, but this should be 1.0.0 when we're ready.
* Run CI against more elixir/OTP versions * Run CI on all pushes and PRs, not just against main * Remove fancy new guard so we can support older Elixir
| <%!-- this wraps text... why does it take in `axis`?? if we want to follow the SVG, we need to pass in `x` --%> | ||
| <.x_axis_label axis={@x_axis} value={~D[2023-08-02]} position={:top} color="red"> | ||
| {"Important Day"} | ||
| </.x_axis_label> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These components haven't really undergone a thorough re-think yet. You might be right that we need to change attribute names and/or change the component names.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I think we just wrap this with another name "vertical marker" or whatever.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah just realized that you forgot that you are the right one since old-you wrote this comment haha
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lol, yeah I can't remember which comments were left by me and which weren't...
| def slice(_) do | ||
| {:error, Plox.DatasetAxis} | ||
| end | ||
|
|
||
| def member?(_, _) do | ||
| {:error, Plox.DatasetAxis} | ||
| end | ||
|
|
||
| def count(_) do | ||
| {:error, Plox.DatasetAxis} | ||
| end |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some of these on the other hand we may actually want to implement someday. I think for things like Enum.count(@dataset[:x]) or if ~D[2025-01-01] in @dataset[:x]? Maybe it makes sense in some cases but not others... e.g. counting an axis with a continuous number scale doesn't make sense...
Several steps towards version
1.0.0✨ Takes @doughsay'selixirconf-rewritebranch and...polylineandstep_polylineto matchcirclescomponentTODOs: