Rework of documentation in problem classes #333
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## master #333 +/- ##
==========================================
- Coverage 72.68% 72.67% -0.01%
==========================================
Files 256 256
Lines 21355 21350 -5
==========================================
- Hits 15521 15516 -5
Misses 5834 5834
☔ View full report in Codecov by Sentry. |
tlunet
reviewed
Jul 23, 2023
pySDC/implementations/problem_classes/AdvectionDiffusionEquation_1D_FFT.py
Outdated
Show resolved
Hide resolved
|
Nice work ! |
|
Seems like the pySDC/implementations/problem_classes/AdvectionDiffusionEquation_1D_FFT.py was not tested ... I've added this to the list of problem not tested yet in #223 |
|
Great work, thanks a lot for this! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I reworked the problem classes (#286). I wrote some more detailed documentation for some problem classes. For all classes I also reworked the documentation for the class methods. Unfortunately, there is still much to do, but I think we are much closer to finish the issue #286.
I have no knowledge about many of the problems.. @tlunet told me documentation for problem classes can be reworked if someone will work with that but I guess some problem classes will be untouched in the near future. I could do the rest but I need references for the problems to finish up the documentations to write down the equations for them..