Mostly parameters related updates to docs #1919
Merged
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.
What is the change?
Some docs/docstring edits!
Giving more links to the parameter module intro as well as adding info about how to get units of a parameter.
Also added a little clarification based on a stumble they had while walking through the user manual (the UM leads you to have
r
, noto.r
, but there's plenty of ways you end up with one or the other)Why is the change being made?
A user was asking me some questions, and it exposed some potential docs improvements.
Checklist
doc
folder.pyproject.toml
.