Document Snake Tutorial Blocks #180
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
Codecov Report
@@ Coverage Diff @@
## devel #180 +/- ##
==========================================
+ Coverage 70.63% 70.68% +0.05%
==========================================
Files 59 59
Lines 23083 23125 +42
==========================================
+ Hits 16304 16346 +42
Misses 6779 6779
Continue to review full report at Codecov.
|
Kryptos-FR
reviewed
Mar 15, 2022
satendrapalsingh
force-pushed
the
docs_blocks
branch
2 times, most recently
from
8c0a5e1
to
db25e5e
Compare
satendrapalsingh
changed the title
GUI.Text
Kryptos-FR
added
the
Project: Documentation
16 tasks
There was a problem hiding this comment.
@sinkingsugar , @Kryptos-FR , @guusw - Should I remove the note I have added in Details page for "Binary operations on sequences" ? I added it to explain how such binary operations on sequences could useful in computing table values. But maybe talking about 2D/3D grids might confuse the user w.r.t to the already existing matrix multiplication operator Math.MatMul, no?
*Talking about this commit
Kryptos-FR
reviewed
Apr 22, 2022
satendrapalsingh
force-pushed
the
docs_blocks
branch
5 times, most recently
from
51c6db5
to
3734305
Compare
Kryptos-FR
reviewed
Apr 27, 2022
Kryptos-FR
reviewed
Apr 28, 2022
satendrapalsingh
force-pushed
the
docs_blocks
branch
5 times, most recently
from
8386aca
to
613b8fe
Compare
satendrapalsingh
force-pushed
the
docs_blocks
branch
from
e48db20
to
13a4186
Compare
|
Addressed all review comments and fixup'd the commits. |
> Add definition > Rewrite parameter definitions for clarity > Add sample codes to explain the block > Add details section
Specifically for `Math.Add` & `Math.Multiply` (and in general for all Math binary operators), ehance the > definition text > `:Input` description > `:Operand` parameter description
For both `Math.Add` & `Math.Multiply`: > add sample codes covering all scenarios of inputs (integers, floats, sequences) > add explanatory comments to sample codes
For both `Math.Add` & `Math.Multiply`: > add details section explaining the binary operation and arguments > add a note on binary operation on sequences
Remove special character from the end of the URL
> Add the details section to explain how block works > Add sample code to illustrate block usage > Enhance parameter description
> Add the details section to explain how block works > Add sample code to illustrate block usage > Enhance parameter description
> New definition text inserted for block `Log` > New definition text inserted for block `Msg`
> Enhance definition, parameters, input, & output descriptions > Add details section > Add relevant code samples to illustrate block usage
> Enhance definition, parameters, input, & output descriptions > Add details section > Add relevant code samples to illustrate block usage
> Enhance parameter help text > Add definition, inputTypes, and outputTypes description text > Add sample code to demonstrate block usage
> Enhance parameter help text > Add definition, inputTypes, and outputTypes description text > Add sample code to demonstrate block usage
> Enhance parameter help text > Add definition, inputTypes, and outputTypes description text > Add sample code to demonstrate block usage
> Enhance parameter help text > Add definition, inputTypes, and outputTypes description text > Add sample code to demonstrate block usage
> Enhance parameter help text > Add definition description text > Add sample code to demonstrate block usage
satendrapalsingh
force-pushed
the
docs_blocks
branch
from
13a4186
to
f583f79
Compare
sinkingsugar
approved these changes
May 3, 2022
Kryptos-FR
approved these changes
May 3, 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.
Raising a draft PR to recieve early feedback on
GUI.Textdocumentation. Other block documentation in progress.