This repository has been archived by the owner on Jun 28, 2022. It is now read-only.
sample: add description for sample function #2290
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 @@
## master #2290 +/- ##
=========================================
Coverage 86.75% 86.75%
Complexity 5134 5134
=========================================
Files 452 452
Lines 20400 20400
Branches 2190 2190
=========================================
Hits 17699 17699
Misses 1930 1930
Partials 771 771Continue to review full report at Codecov.
|
vchudnov-g
approved these changes
Sep 6, 2018
There was a problem hiding this comment.
Two comments: one about spacing and the following one about the proto:
Could you expand the comment in the proto to indicate that description may appear in the sample? I suggest:
// A longer description for this set of values. This may be
// used in the sample itself or in a UI element such as hoverbox.
| @end | ||
|
|
||
| def sample_{@apiMethod.name}({@sampleFuncParam(sample.initCode.argDefaultParams)}): | ||
| """ {@sample.valueSet.description} """ |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
No description provided.