Improve the DSL docs page #146
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
KipHamiltons
commented
Sep 1, 2024
| @@ -1,4 +1,4 @@ | |||
| include .special.rst | |||
| .. include:: .special.rst | |||
There was a problem hiding this comment.
This is literally at the top of the page. Yikes
https://nuclear.readthedocs.io/en/latest/dsl.html
| <font color="blue">DSL Request</font><br /> | ||
|
|
||
| This is :red:`red !` And :blue:`this part is blue`. | ||
| :blue:`On<Dsl, Word(s)>`\(:red:`Runtime, Args`).then(:green:`CallbackFunction`); |
There was a problem hiding this comment.
If we want to use rst, we should actually use it.
Also, that escaped paren is deliberate. It's required after the backtick
| Finally, the developer can define the callback which will execute when the reaction is triggered during runtime. The | ||
| callback can be defined using a C++ lambda function. | ||
| callback can be defined using a C++ lambda expression. |
| these emissions can take place: | ||
|
|
||
| .. todo:: | ||
|
|
||
| Trent - I need to decide and get consistent on what we will call the powerPlant. Should it be PowerPlant or |
There was a problem hiding this comment.
Making an executive decision here
TrentHouliston
approved these changes
Sep 1, 2024
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.
Mostly pretty easy stuff. Opted for
rstfeatures instead of HTML as well.