Updating documentation to be more explicit in simulation block #70
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
hernando
reviewed
Nov 29, 2018
| <td>Default</td> | ||
| </tr> | ||
| <tr> | ||
| <td>tstart</td> |
There was a problem hiding this comment.
rename to start_time for consistency with the reports sections
There was a problem hiding this comment.
@apdavison, @salvadord, @pgleeson, are you OK with the suggested renaming?
| <td>0.0</td> | ||
| </tr> | ||
| <tr> | ||
| <td>tstop</td> |
There was a problem hiding this comment.
rename to end_time for consistency
| <td></td> | ||
| </tr> | ||
| <tr> | ||
| <td>block_step_size</td> |
There was a problem hiding this comment.
This name is not very clear. If I understand the description correctly I'd rename it to "reporting_skipped_frames" , "skipped_frames", "skip_report_frames", "reporting_start_frame"
I'd also use double for all timestamps, but I think that this is irrelevant for json anyway (isn't number the actual typename in any case?)
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.
A fix to issue #52 (and #22), explicitly adding the definition of "dL" parameter in the "run" block of the simulation config.
I went a head and added a table for all the attributes in the block.