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

start docs for MixedDofHandler #426

Merged
merged 1 commit into from
Feb 27, 2022
Merged

start docs for MixedDofHandler #426

merged 1 commit into from
Feb 27, 2022

Conversation

kimauth
Copy link
Member

@kimauth kimauth commented Feb 22, 2022

A start to add some documentation for the MixedDofHandler. The Common methods section could still use some love, just added the docstrings that were already there in the code.

@@ -1,15 +1,30 @@
"""
Field(name::Symbol, interpolation::Interpolation, dim::Int)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Field(name::Symbol, interpolation::Interpolation, dim::Int)
Field(name::Symbol, interpolation::Interpolation, dim::Int)

Noticed formatting missing while reading the preview doc...

@termi-official
Copy link
Member

I guess the long term goal is now to keep both handlers as separate entities?

@kimauth
Copy link
Member Author

kimauth commented Feb 24, 2022

This PR isn't supposed to make a decision on that, it would still be nice to join them to one DofHandler.
But for now I don't think anyone is actively working on that and the MixedDofHandler is completely undocumented while allowing for some really nice functionality.

@kimauth kimauth merged commit f995d04 into master Feb 27, 2022
@kimauth kimauth deleted the ka/MixedDofHandler_docs branch February 27, 2022 18:54
koehlerson pushed a commit that referenced this pull request Apr 22, 2022
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.

None yet

4 participants