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

grid manual update and new docs for mesh reading #504

Merged
merged 11 commits into from
Oct 6, 2022

Conversation

koehlerson
Copy link
Member

No description provided.

@codecov-commenter
Copy link

codecov-commenter commented Oct 4, 2022

Codecov Report

Base: 91.99% // Head: 92.00% // Increases project coverage by +0.01% 🎉

Coverage data is based on head (e136fec) compared to base (523f700).
Patch has no changes to coverable lines.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #504      +/-   ##
==========================================
+ Coverage   91.99%   92.00%   +0.01%     
==========================================
  Files          22       22              
  Lines        3673     3703      +30     
==========================================
+ Hits         3379     3407      +28     
- Misses        294      296       +2     
Impacted Files Coverage Δ
src/Dofs/MixedDofHandler.jl 86.39% <0.00%> (-0.92%) ⬇️
src/Grid/coloring.jl 92.43% <0.00%> (+0.12%) ⬆️
src/Dofs/DofHandler.jl 89.16% <0.00%> (+0.15%) ⬆️
src/Dofs/ConstraintHandler.jl 93.27% <0.00%> (+0.28%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@koehlerson
Copy link
Member Author

should the added section be moved to manual?

@KnutAM
Copy link
Member

KnutAM commented Oct 5, 2022

should the added section be moved to manual?

I think that would be good!
Then, perhaps it makes sense to rename the header to "How to obtain a mesh" (or grid),
and have sub-headers: generate_grid, FerriteGmsh.jl, FerriteMeshParser.jl?
I'm not sure if this should come before or after the description of the Grid type though.
First-time users would primarily be interested in how to obtain meshes. But part of the descriptions rely on basic knowledge about the Grid-type

Copy link
Member

@KnutAM KnutAM left a comment

Choose a reason for hiding this comment

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

Looks good, just a few minor things that I saw.
Perhaps we should change the PR name since this turned into restructuring the grid documentation as well.

docs/src/manual/grid.md Outdated Show resolved Hide resolved
docs/src/manual/grid.md Outdated Show resolved Hide resolved
docs/src/manual/grid.md Show resolved Hide resolved
docs/src/manual/grid.md Outdated Show resolved Hide resolved
@KnutAM KnutAM added the docs label Oct 6, 2022
@koehlerson koehlerson changed the title togrid docstrings and mention the two examples which actually use it grid manual update and new docs for mesh reading Oct 6, 2022
@fredrikekre fredrikekre merged commit 2b8689d into master Oct 6, 2022
@fredrikekre fredrikekre deleted the mk/FerriteGmsh_Docs branch October 6, 2022 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants