-
Notifications
You must be signed in to change notification settings - Fork 92
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
More Grid Docs, mostly related to API Reference #306
Conversation
Codecov Report
@@ Coverage Diff @@
## master #306 +/- ##
=======================================
Coverage 85.84% 85.84%
=======================================
Files 21 21
Lines 1999 1999
=======================================
Hits 1716 1716
Misses 283 283
Continue to review full report at Codecov.
|
I still have to add in the utility function sections that these should be dispatched on a custom |
Codecov Report
@@ Coverage Diff @@
## master #306 +/- ##
=======================================
Coverage 91.03% 91.03%
=======================================
Files 22 22
Lines 2855 2855
=======================================
Hits 2599 2599
Misses 256 256
Continue to review full report at Codecov.
|
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.
First big round. I think a major issue is that we do not specify what the interface does, but leak implementation details of the default grid implementation. We should focus more on what is happening conceptually.
ready for review again :) |
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.
Got two more minor points and some missing dots. If this is fixed the PR should be ready.
Co-authored-by: Dennis Ogiermann <[email protected]>
Co-authored-by: Dennis Ogiermann <[email protected]>
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.
LGTM
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.
Looks really good to me!
Co-authored-by: Kim Louisa Auth <[email protected]>
* more grid docs, this time API reference, mostly focusing with subtyping AbstractGrid * fix missing reference in docs deploy * include *Index in docs * update docs according to review and discussions * Update src/Grid/grid.jl Co-authored-by: Dennis Ogiermann <[email protected]> * Apply suggestions from code review Co-authored-by: Dennis Ogiermann <[email protected]> * add comment about dimension * Update src/Grid/grid.jl Co-authored-by: Kim Louisa Auth <[email protected]> Co-authored-by: Dennis Ogiermann <[email protected]> Co-authored-by: Kim Louisa Auth <[email protected]>
Continued the grid docs, but this time focusing on the API reference. I tried to include everything which is relevant for subtyping
AbstractGrid
. Hopefully, it will be easier now to understand howGrid
works, but also how one can subtypeAbstractGrid
and define a suitable interface for JuAFEM