Document go code snippets as examples #495
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
smallhive
requested review from
roman-khimov,
cthulhu-rider and
carpawell
as code owners
There was a problem hiding this comment.
It'd be great to make our examples more useful. Calling one function doesn't help, examples should show how things interact within the SDK to achieve some end-user goal, what are the prerequisites for some actions and how to properly process results of some calls.
smallhive
force-pushed
the
204-document-go-code-snippets-as-examples
branch
from
9a7cf84
to
2d3b2b2
Compare
smallhive
force-pushed
the
204-document-go-code-snippets-as-examples
branch
from
2d3b2b2
to
250b7fd
Compare
smallhive
force-pushed
the
204-document-go-code-snippets-as-examples
branch
from
250b7fd
to
207fa87
Compare
smallhive
force-pushed
the
204-document-go-code-snippets-as-examples
branch
from
207fa87
to
c512d8d
Compare
carpawell
reviewed
Aug 25, 2023
There was a problem hiding this comment.
- 8e83055: "Example with RCP..."
- Most of the commits are "remove" but in fact they are "move". But that is cosmetic
- Really often saw
// send msg,// fill containerbut it should be// *send msg*instead. Not to confuse a reader, IMO
smallhive
force-pushed
the
204-document-go-code-snippets-as-examples
branch
from
c512d8d
to
439a485
Compare
Signed-off-by: Evgenii Baidakov <evgenii@nspcc.io>
Signed-off-by: Evgenii Baidakov <evgenii@nspcc.io>
Signed-off-by: Evgenii Baidakov <evgenii@nspcc.io>
Signed-off-by: Evgenii Baidakov <evgenii@nspcc.io>
smallhive
force-pushed
the
204-document-go-code-snippets-as-examples
branch
from
439a485
to
806a9d9
Compare
roman-khimov
approved these changes
Aug 25, 2023
Example with RPC left in the code, because it can't be properly represented with examples. Signed-off-by: Evgenii Baidakov <evgenii@nspcc.io>
Signed-off-by: Evgenii Baidakov <evgenii@nspcc.io>
Signed-off-by: Evgenii Baidakov <evgenii@nspcc.io>
Signed-off-by: Evgenii Baidakov <evgenii@nspcc.io>
Signed-off-by: Evgenii Baidakov <evgenii@nspcc.io>
Signed-off-by: Evgenii Baidakov <evgenii@nspcc.io>
Signed-off-by: Evgenii Baidakov <evgenii@nspcc.io>
Signed-off-by: Evgenii Baidakov <evgenii@nspcc.io>
Signed-off-by: Evgenii Baidakov <evgenii@nspcc.io>
Signed-off-by: Evgenii Baidakov <evgenii@nspcc.io>
Signed-off-by: Evgenii Baidakov <evgenii@nspcc.io>
Signed-off-by: Evgenii Baidakov <evgenii@nspcc.io>
Signed-off-by: Evgenii Baidakov <evgenii@nspcc.io>
Signed-off-by: Evgenii Baidakov <evgenii@nspcc.io>
smallhive
force-pushed
the
204-document-go-code-snippets-as-examples
branch
from
806a9d9
to
5d5544e
Compare
carpawell
approved these changes
Aug 28, 2023
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.
closes #204