Add documentation to [Raster], [Blob] and [RoundedRect] #354
Conversation
This file contains hidden or 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
I've changed the order of the parameters here to be neater, but I won't be doing that on other ops going forward.
ylmrx
reviewed
Jan 25, 2024
| }, | ||
| { | ||
| "InputId": "d2401798-593b-4cc3-85d8-3570ddec1f2a"/*Scale*/, | ||
| "Position": { | ||
| "X": -212.96689, | ||
| "Y": 167.20885 | ||
| }, | ||
| "Description": "Scales the shape uniformly.", |
There was a problem hiding this comment.
be consistant w/ line 44 : use "Stretches" here.
There was a problem hiding this comment.
I've used "stretches" for nonuniform scaling and "scales" for uniform scaling, to match the parameters' names. If it would be better to use the same word throughout, I'll change both to "scales".
ylmrx
reviewed
Jan 25, 2024
| @@ -1,68 +1,77 @@ | |||
| { | |||
| "Id": "4f89b41b-1643-442b-bec8-9f9ef2173baa"/*Raster*/, | |||
| "Description": "Generates a wide range of different raster patterns. You can also connect an input texture to drive various aspects of the pattern.", | |||
| "Description": "Generates a wide range of patterns of dots and lines.\n\nConnecting a texture to the Image input will allow the pattern to be influenced differently at different parts of the texture.\n\nAKA: polkadot, pattern, grid, crosshair", | |||
There was a problem hiding this comment.
"The image input let the pattern be influenced by its content (reference the channel" (texture is redundant, and the passive form is a bit confusing)
There was a problem hiding this comment.
Yes, this line is very clunky in hindsight... Thanks for catching that! Will revise it (might be able to just remove it entirely in fact.)
|
Thanks a lot for that great contribution! |
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.
Also renamed some parameters to be more consistent, and altered the layout of [Raster] to group similar parameters together. I won't be doing many more layout changes in the near future though, since we don't have a convention for them yet.