Skip to content
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

Merged
merged 11 commits into from
Jan 18, 2022
Merged

Conversation

koehlerson
Copy link
Member

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 how Grid works, but also how one can subtype AbstractGrid and define a suitable interface for JuAFEM

@codecov-io
Copy link

codecov-io commented Nov 25, 2020

Codecov Report

Merging #306 (47f4906) into master (40e515b) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #306   +/-   ##
=======================================
  Coverage   85.84%   85.84%           
=======================================
  Files          21       21           
  Lines        1999     1999           
=======================================
  Hits         1716     1716           
  Misses        283      283           
Impacted Files Coverage Δ
src/Grid/grid.jl 83.72% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 40e515b...47f4906. Read the comment docs.

@koehlerson
Copy link
Member Author

I still have to add in the utility function sections that these should be dispatched on a custom AbstractGrid subtype in case someone wants to use their own grid format. What do you think, should I append it below, put it at the top? I think right now I'd put it on top of the section and immediately afterwards a Documenter @index block listing all neccessary functions.

@codecov-commenter
Copy link

codecov-commenter commented Oct 5, 2021

Codecov Report

Merging #306 (1ad1c1c) into master (bd44c89) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #306   +/-   ##
=======================================
  Coverage   91.03%   91.03%           
=======================================
  Files          22       22           
  Lines        2855     2855           
=======================================
  Hits         2599     2599           
  Misses        256      256           
Impacted Files Coverage Δ
src/Grid/grid.jl 86.62% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bd44c89...1ad1c1c. Read the comment docs.

Copy link
Member

@termi-official termi-official left a 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.

src/Grid/grid.jl Outdated Show resolved Hide resolved
src/Grid/grid.jl Outdated Show resolved Hide resolved
src/Grid/grid.jl Outdated Show resolved Hide resolved
src/Grid/grid.jl Outdated Show resolved Hide resolved
src/Grid/grid.jl Outdated Show resolved Hide resolved
src/Grid/grid.jl Show resolved Hide resolved
src/Grid/grid.jl Outdated Show resolved Hide resolved
src/Grid/grid.jl Show resolved Hide resolved
src/Grid/grid.jl Outdated Show resolved Hide resolved
src/Grid/grid.jl Outdated Show resolved Hide resolved
@koehlerson
Copy link
Member Author

ready for review again :)

Copy link
Member

@termi-official termi-official left a 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.

src/Grid/grid.jl Outdated Show resolved Hide resolved
src/Grid/grid.jl Outdated Show resolved Hide resolved
src/Grid/grid.jl Outdated Show resolved Hide resolved
src/Grid/grid.jl Outdated Show resolved Hide resolved
src/Grid/grid.jl Outdated Show resolved Hide resolved
src/Grid/grid.jl Outdated Show resolved Hide resolved
src/Grid/grid.jl Outdated Show resolved Hide resolved
src/Grid/grid.jl Outdated Show resolved Hide resolved
src/Grid/grid.jl Outdated Show resolved Hide resolved
src/Grid/grid.jl Outdated Show resolved Hide resolved
Copy link
Member

@termi-official termi-official left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Member

@kimauth kimauth left a 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!

docs/src/reference/grid.md Show resolved Hide resolved
src/Grid/grid.jl Show resolved Hide resolved
@koehlerson koehlerson merged commit bbd88a0 into master Jan 18, 2022
@koehlerson koehlerson deleted the grid-docs branch January 18, 2022 12:09
koehlerson added a commit that referenced this pull request Apr 22, 2022
* 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants