clarify that the "height" in a disk region is from the midplane #2503
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
|
please don't merge yet -- we will use this for the tutorial tomorrow on contributing to yt |
munkm
requested changes
Mar 25, 2020
There was a problem hiding this comment.
Hi @zingale! Thank you so much for this doc fix. I agree that the original docs are unclear about the height and our users could get tripped up here. However, I think you could be even more clear in this documentation improvement by saying that the height entered is half that of the cylinder object that's created. What do you think?
munkm
approved these changes
Mar 25, 2020
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.
PR Summary
During our yt tutorial today, it came up that the disk region was a little confusing in that the height is measured from the midplane and not top to bottom of the cylinder. This PR adds a clarification to the region objects overview docs.
PR Checklist