-
Notifications
You must be signed in to change notification settings - Fork 14
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 docs fixes #128
Add docs fixes #128
Conversation
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## main #128 +/- ##
=======================================
Coverage 88.40% 88.40%
=======================================
Files 9 9
Lines 1009 1009
=======================================
Hits 892 892
Misses 117 117 ☔ View full report in Codecov by Sentry. |
It looks like this closes just the climate model docs problems, but we still need to update the old examples |
@lukem12345 ready to merge this? |
@jpfairbanks Not yet, but I'll push docs changes that I have made. Some of the encoding of boundary conditions in the Poiseuille flow were handled strangely before we settled on current best practices. Also, need to double-check Diffusion-Advection and Boundary Conditions pages |
Going to push fixes for |
Nice, I am working on a new docs page using simple equations to go after overview for ASKEM. |
Great! On an editorial note: I am wondering what the value we are getting out of using the Defining diffusion/ the Laplacian this way:
However:
I think making this change is a demonstration of the principle that composition should be performed:
Without any of the above reasons, it delves somewhat into composition for composition's sake. |
I think it would be fine to use Laplacian everywhere we do diffusion and add a new docs page showing composition and aliases. I'll make a new issue to track composite operators. I'd like to get the old docs restored to main ASAP and then address general docs improvement in additional PRs |
I did the merge conflicts |
Added in versions of BC and Overview that should be correct barring git pulling and pushing doing odd things. Poiseuille is partially fixed. The way that boundary conditions happened in the original Poiseuille doc was against current conventions, so this page has taken longer to work through. It will be shorter and clearer after that process is done, which is good. In the meantime, BC and Overview docs can be merged through whatever git strategies of choice. (cherry-pick overview and bc changes onto a different branch, make a commit that removes changes to Poiseuille in this branch, etc.) |
Looks like the environment on the GitHub action is slightly different than my local system for whatever reason. Some paths are getting mixed. I'll change some relative paths. |
I'm going to merge this and if you have more docs updates, they can go in a new PR. |
Close #127