Operator Documentation Table for DEC - #343
wkunzendorf-hub wants to merge 13 commits into
Conversation
Small edits to DEC operator table documentation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #343 +/- ##
==========================================
+ Coverage 77.83% 77.88% +0.05%
==========================================
Files 5 5
Lines 636 633 -3
==========================================
- Hits 495 493 -2
+ Misses 141 140 -1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This DEC Table update includes map notation for each of the operators. It also includes edits to make the transition from markdown code to an html format.
Final update for the DEC Operator Table Rough Draft before George reviews it.
|
Here is the updated DEC Table documentation for you to review George. @GeorgeR227 |
|
@wkunzendorf-hub Don't forget to upload the changes to the |
These are the edits based on George Rauta's recommendations. Improvements include: putting Reference section at the bottom, creating Signature subheadings, rephrasing wording, and fixing LaTeX errors.
Adding DEC Op Table to the make.jl file.
List of different changes made: 1. Fixed Latex to match Documenter.jl 2. Corrected any mistakes in math 3. Edited some explanations for clarity 4. Added some external links for readers 5. Replaced Unicode with Latex commands 6. Fixed some formatting issues (white space after line end)
|
I've completed the review of this documentation and all things appear to be good. Initial documentation was very thorough but some typos remained which are now fixed and some explanations were clarified for readers. For the future, writing documentation should use the Latex commands and not Unicode symbols. That way the page appearance is more consistent for users. What I mean is using, for example, \omega for the lowercase omega symbol. Also, since this is being rendered with Documenter.jl, which is why this is added to the Once all checks complete I'll merge this into main. |
GeorgeR227
left a comment
GeorgeR227
left a comment
There was a problem hiding this comment.
All changes made and documentation looks good.
2 participants
This is documentation giving a simplified description of the operators in Discrete Exterior Calculus. It covers the boundary, exterior derivative, wedge product, hodge star, flat, sharp, codifferential, interior product, lie derivative, and Laplacian operators. Each section includes each operator's code signature, a short description, its important properties, and the information's source(s).