Generate TUI documentation #450
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
Contributor
mkundu1
commented
Jun 2, 2022
mkundu1
commented
|
Will fix the warnings coming from the TUI docstrings |
mkundu1
requested review from
smf2001,
dnwillia-work,
ajain-work and
seanpearsonuk
smf2001
approved these changes
Jun 2, 2022
ajain-work
approved these changes
Jun 2, 2022
| @@ -35711,8 +35711,7 @@ the periodic repeat.</p> | |||
| </sect2> | |||
| <sect2 id="flu_meshing_file_start_transcript"> | |||
| <h3>file/start-transcript</h3> | |||
| <p>Starts recording input and output in a file. A transcript file contains a complete record of all standard input to and output from Fluent (usually all keyboard and user interface input and all screen output).Start the transcription process with the <systemitem moreinfo="none">file/start-transcript</systemitem> command, and end it with the <systemitem moreinfo="none">file/stop-</systemitem> | |||
| <systemitem moreinfo="none">transcript</systemitem> command (or by exiting the program). <indexterm significance="normal"> | |||
| <p>Starts recording input and output in a file. A transcript file contains a complete record of all standard input to and output from Fluent (usually all keyboard and user interface input and all screen output).Start the transcription process with the <systemitem moreinfo="none">file/start-transcript</systemitem> command, and end it with the <systemitem moreinfo="none">file/stop-transcript</systemitem> command (or by exiting the program). <indexterm significance="normal"> | |||
There was a problem hiding this comment.
Should we not read this content from the Fluent install used to generate the TUI doc? No need to change it, just wondering.
There was a problem hiding this comment.
Yeah, we should copy this file from the docker image instead of checking it in. For now, I'll create an issue for tracking.
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.