Revamp the README #53
Merged
Conversation
This file contains 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
|
|
||
| ## Options | ||
| Positions `(x, y, ...)` are n-tuples of numbers. Typically these will | ||
| be real-valued (not necessarily integer-valued), but can also be types |
There was a problem hiding this comment.
I'd say the positions can be of types - we support sending in 1.0 + 1.0du, but not Dual{Float64}... It's a small difference (in wording - bigger semantically), but I think it pays to be nit-picky in documentation :)
|
Wonderful writing, as always :) I had only one nit-pick (see the line comment) - not sure if I can edit that directly on your branch or not. If you don't have time to edit that, just merge as-is and I'll fix it afterwards. Thanks a lot for taking the time to shape this up! |
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.
To me it seems time to "advertise" this package a little more broadly, so I'll have a few PRs tweaking things. This one brings the README into sync with current syntax. Any and all suggestions welcome, of course.