-
Notifications
You must be signed in to change notification settings - Fork 33
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 Parameter Documentation for Subducting Plate Feature #768
base: main
Are you sure you want to change the base?
Add Parameter Documentation for Subducting Plate Feature #768
Conversation
7f6fec8
to
64bdbe0
Compare
|
64bdbe0
to
68cc9d9
Compare
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.
Thanks for writing this up, very nice! Also cool to see how you made the figures to explain the concepts. I have a few small comments, but otherwise looks good to me.
- I guess you are trying to get into math mode with with the $ around some variables, but it doesn't render correctly. Maybe we to enable an extra plugin in sphinx?
- Currently there is a limitation that the number of segements need to be the same in all sections. Could you add that?
- In the downdip_sections.png figure, the black cross-sections are a bit hard to see. Maybe a lighter color or an outline would help.
68cc9d9
to
839462a
Compare
@MFraters Thanks for the quick review! I addressed points 1 and 2, I just made M and N italicized, I don't think we need to worry about the math mode extension for sphinx at least for this PR. For point 3 I'll remake the figures later tonight, I also think the font should be a little larger, so I will comment at you again when it's ready for you take another look. |
Update the manual by adding the section for the subducting plate feature in parameter documentation, addresses a point in Issue #766.