Skip to content
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

Merged
merged 4 commits into from
Jun 7, 2024
Merged

Conversation

eivindjahren
Copy link
Collaborator

No description provided.

# * "polyfit"
# * "friable_sand"
# * "patchy_cement"
type: "polyfit"
Copy link
Member

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?

Copy link
Collaborator Author

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
Copy link
Member

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).
Copy link
Member

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.

Copy link
Collaborator Author

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.

Copy link
Member

@kwinkunks kwinkunks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@eivindjahren eivindjahren merged commit 5945c89 into main Jun 7, 2024
6 checks passed
@eivindjahren eivindjahren deleted the fix_docs2 branch June 7, 2024 07:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants