Basic Documentation for Spawner Class #5767
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
tdug
commented
Apr 28, 2022
Comment on lines
+2
to
+5
| var genStream; | ||
| var priorityQ; | ||
| var now; | ||
| var event; |
There was a problem hiding this comment.
I did not see any cases of these variables used outside of this class, nor accessed through this. They may as well be private.
tdug
commented
Apr 28, 2022
| @@ -29,8 +29,8 @@ Spawner : Pattern { | |||
| ^stream; | |||
| } | |||
|
|
|||
| seq { | pat | | |||
| pat.embedInStream(event) | |||
| seq { | pattern | | |||
There was a problem hiding this comment.
I changed this argument name to be consistent with the argument name in par. I wouldn't normally do this, but this class is undocumented, and it's unlikely anyone used the keyword argument syntax for this method in their existing code.
tdug
commented
Apr 28, 2022
| @@ -34,7 +34,7 @@ Stop all substreams of the Spawner. | |||
| :: | |||
|
|
|||
| note:: | |||
| We should move the documentation of above methods to the link::Classes/Spawner:: helpfile... | |||
There was a problem hiding this comment.
This was the inspiration for this change.
|
Note to self: make a note of the argument change in the Changelog; me and @joshpar think it's fine. |
joshpar
approved these changes
Oct 21, 2022
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.
Purpose and Motivation
This adds some basic documentation.
Types of changes
To-do list