Clarify documentation of node update() method
#3388
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
clinssen
added
S: Normal
|
This needs a quick review for correctness. Single reviewer should be fine. |
heplesser
requested changes
Feb 27, 2025
Comment on lines
+285
to
+288
| * Advance the state of the node forward in time by one ``min_delay`` | ||
| * interval. Precondition: state of the node corresponds to the time | ||
| * ``origin``. Postcondition: state of the node corresponds to the time | ||
| * ``origin + min_delay``. |
There was a problem hiding this comment.
Doxygen comments should start with a single line with a brief description that can, e.g., be included in a table of classes. And update() does not strictly advance through one min_delay interval: If Simulate is called with a time that is not a multiple of min_delay, we will stop inside a min_delay slice.
Suggested change
| * Advance the state of the node forward in time by one ``min_delay`` | |
| * interval. Precondition: state of the node corresponds to the time | |
| * ``origin``. Postcondition: state of the node corresponds to the time | |
| * ``origin + min_delay``. | |
| * Advance the state of the node in time through the given interval. | |
| * | |
| * This method advances the state of the node through the interval | |
| * ``(origin+from, origin+to]``, which is at most ``min_delay`` long. | |
| * | |
| * - Precondition: State of the node corresponds to the time ``origin+from``. | |
| * - Postcondition: State of the node corresponds to the time ``origin+to``. |
Comment on lines
+290
to
+292
| * This method is called every ``min_delay`` interval, with each step | ||
| * between ``from`` and ``to`` corresponding to one simulation resolution | ||
| * (``nest.resolution``) timestep. |
There was a problem hiding this comment.
This also needs to be updated corresponding to the changes above.
| * Bring the node from state $t$ to $t+n*dt$, sends SecondaryEvents | ||
| * (e.g. GapJunctionEvent) and resets state variables to values at $t$. | ||
| * Advance the state of the node forward in time by one ``min_delay`` | ||
| * interval (see ``update()``); send SecondaryEvents (e.g. GapJunctionEvent) |
There was a problem hiding this comment.
Same points as for update() apply here. Also, can one mark up the "see update()" here in such a way that update() becomes a hyperlink to the documentation for update?
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.
No description provided.