[docs] Added additional explanations #4059
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
github-actions
bot
added
the
Type: Documentation
emmazzz
approved these changes
Aug 17, 2022
Clay-Mysten
approved these changes
Aug 17, 2022
doc/src/build/cli-client.md
Outdated
| @@ -998,6 +998,9 @@ Please see the [Move developer documentation](move/index.md) for a | |||
| description on how to [write a simple Move code package](move/write-package.md), | |||
| which we can publish using Sui client's `publish` command. | |||
|
|
|||
| > **Important:** All calls to functions in the `debug` module must be removed from no-test code | |||
There was a problem hiding this comment.
What do we mean by "no-test code" here? I see no other reference on this page.
There was a problem hiding this comment.
Added additional explanation in both places.
There was a problem hiding this comment.
Added additional explanation in both places.
Thanks, Adam! LGTM.
| @@ -21,6 +21,9 @@ debug::print_stack_trace(); | |||
| ``` | |||
| Alternatively, any call to `abort` or assertion failure will also print the stacktrace at the point of failure. | |||
|
|
|||
| > **Important:** All calls to functions in the `debug` module must be removed from no-test code | |||
There was a problem hiding this comment.
Same comment as above. Let's make both references to "no-test code" clear.
|
I'm adding this to the newly moved |
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.
Some of the missing explanations that affect user experience.