Add worked example to dim-si README#6
Closed
dyreby wants to merge 2 commits intodocs/type-annotations-compound-unitsfrom
Closed
Add worked example to dim-si README#6dyreby wants to merge 2 commits intodocs/type-annotations-compound-unitsfrom
dyreby wants to merge 2 commits intodocs/type-annotations-compound-unitsfrom
Conversation
Show a complete kinetic energy calculation with typed functions, demonstrating dimensional analysis catching errors in context. Addresses #4
Contributor
|
A few concerns with this PR as-is:
Rather than a separate worked example, I think the better move is to expand the Quick Start to show more operations (multiplication, division, scaling) using the fluent API. I have pushed a commit to this branch that does that and removes the worked example section. The free functions get a one-line mention instead of a code block. Please take a look and let me know what you think. |
Replace the worked example section with a richer Quick Start that demonstrates division, multiplication, scaling, and addition — all using the fluent q() API. Free functions get a one-line mention.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a "Worked Example" section showing a complete kinetic energy calculation (KE = ½mv²).
Demonstrates:
Quantity<Mass>,Quantity<Velocity>,Quantity<Energy>multiply,scale)valueInwith joule/kilojoule)Stacked on #5 — merge that first.
Closes #8