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.
This request includes updates to the documentation related to file input/output in the
data.rst
andquickstart.rst
files. The changes provide more detailed information to users. A follow up request will propose to move the File I/O section out of data.rst to a dedicated configuration.rst file and add a new "Configuration and File I/O" section to the docs, including updating the TOC and anything needed to compile. The changes to the actual content are proposed here first by updating data.rst for easier comparison with existing content, before moving it to a dedicated section in the docs. Double check the updated file and parameter descriptions, especially the new Output File table at the end of data.rst.Changes Include:
These updates aim to make the examples and docs more user-friendly especially for new users to understand the file inputs and outputs and how to setup the example configuration.
The branch name for these changes is
docs-update-file-i/o
.