swagger.yaml edits for liquidity module #356
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 @@
## develop #356 +/- ##
========================================
Coverage 83.26% 83.26%
========================================
Files 20 20
Lines 2247 2247
========================================
Hits 1871 1871
Misses 207 207
Partials 169 169 Continue to review full report at Codecov.
|
This was referenced May 20, 2021
jaybxyz
reviewed
May 21, 2021
| @@ -32,7 +32,7 @@ paths: | |||
| The id of the pool_type to use as pool_type_id for | |||
| pool creation. | |||
|
|
|||
| Only pool-type-id 1 is supported | |||
| Only pool-type-id 1 is supported. | |||
There was a problem hiding this comment.
If the sentence should end with a dot, then we should maybe put a dot in the other sentences?
There was a problem hiding this comment.
thanks for noticing @kogisin
- for title, the style is not to use punctuation (dot) at the end of the sentence
(our titles are probably longer than appropriate, I need to learn more) - for description, we do need punctuation at the end of complete sentences
|
@kogisin can you take a look at the minor changes I just introduced, so make sure all is accurate and as expected? |
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.
Description
swagger.yaml edits for liquidity module
question: do we want a message description for block heights to be "is" or "was"
in this PR, I am suggesting to use present tense (although I was tempted to use the past tense, I don't know enough yet to make a firm recommendation)
I think that we are recording the block height "when this message was appended" ??
closes: part of #217
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/) or specification (x/<module>/spec/)godoccomments.Unreleasedsection inCHANGELOG.mdFiles changedin the Github PR explorerCodecov Reportin the comment section below once CI passes