Naming changes, comments, and consistent formatting #13
Conversation
This file contains hidden or 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
devmotion
commented
Jul 7, 2017
| """ | ||
| savevalues!(integrator::DDEIntegrator, force_save=false) | ||
| Update solution of `integrator`, if necessary or forced by `force_save`. |
There was a problem hiding this comment.
According to the Julia documentation guide lines, "In general, only the most generic method should be documented" - so maybe this (and other docstrings in integrator_interface.jl) should be moved to OrdinaryDiffEq.jl rather?
There was a problem hiding this comment.
I think it's fine to have it both places. I'll accept it here.
Codecov Report
@@ Coverage Diff @@
## master #13 +/- ##
==========================================
- Coverage 79.26% 78.04% -1.22%
==========================================
Files 8 8
Lines 164 164
==========================================
- Hits 130 128 -2
- Misses 34 36 +2
Continue to review full report at Codecov.
|
ChrisRackauckas
approved these changes
Jul 7, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Hi!
I finally found the time to separate the naming changes and comments, together with some new additions, from #12. Moreover, I reformatted most parts of the code to follow the Julia guidelines for code contributions, since the same conventions, like e.g. line breaks after 92 characters, should apply to docstrings anyway.
Beside that, the only change to the code is the replacement of
typewithstruct- or should these changes be moved to another PR?I guess, the most comments are added to
integrator_interface.jlandsolve.jl- hopefully they can help for understanding the implementation.