-
Notifications
You must be signed in to change notification settings - Fork 9
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
Add better description of pressure dependency #54
Conversation
# * "polyfit" | ||
# * "friable_sand" | ||
# * "patchy_cement" | ||
type: "polyfit" |
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.
Is it idiomatic to use quotes for strings in this library? Seems a bit noisy?
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.
Right, I'll do away with those.
density: [[0.0, 1.35], [1.0, 0.0]] | ||
``` | ||
|
||
In the above example, the dry_rock material changes both with depth and pressure according to |
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.
Might be nice to use backticks for the names of things,eg dry_rock
, pressure_dependency
, etc. Personally I find this helps read docs with a lot of names floating about.
|
||
In the above example, the dry_rock material changes both with depth and pressure according to | ||
the "depth_trend" and "pressure_dependency" adjustment. Depth trend simply adjusts the material | ||
according to a two dimensional polynomial (see the above example for details). |
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.
Maybe just use one line per paragraph and let everything wrap? Would prefer to the mixture of line breaks and wrapped lines. But whatever is currently usual in this library I guess.
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.
I used linewrap everywhere else, and I prefer it that way unfortunately 🫠 . I have worked in some projects that use linewrap for natural text and personally I really didn't like it.
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.
Nice!
No description provided.