v043 audit changes for types/ (#9290)

cosmos · May 17, 2021 · 321aed8 · 321aed8
1 parent 589c67d
commit 321aed8
Show file tree

Hide file tree

Showing 9 changed files with 8 additions and 10 deletions.
diff --git a/docs/core/proto-docs.md b/docs/core/proto-docs.md
@@ -715,7 +715,7 @@ pagination. Ex:
 | `offset` | [uint64](#uint64) |  | offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
 | `limit` | [uint64](#uint64) |  | limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
 | `count_total` | [bool](#bool) |  | count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
-| `reverse` | [bool](#bool) |  | reverse is set to true indicates that, results to be returned in the descending order. |
+| `reverse` | [bool](#bool) |  | reverse is set to true if results are to be returned in the descending order. |
 
 
 

diff --git a/proto/cosmos/base/query/v1beta1/pagination.proto b/proto/cosmos/base/query/v1beta1/pagination.proto
@@ -31,7 +31,7 @@ message PageRequest {
   // is set.
   bool count_total = 4;
 
-  // reverse is set to true indicates that, results to be returned in the descending order.
+  // reverse is set to true if results are to be returned in the descending order.
   bool reverse = 5;
 }
 

diff --git a/proto/cosmos/base/reflection/v1beta1/reflection.proto b/proto/cosmos/base/reflection/v1beta1/reflection.proto
@@ -41,4 +41,4 @@ message ListImplementationsRequest {
 // RPC.
 message ListImplementationsResponse {
   repeated string implementation_message_names = 1;
-}
+}
diff --git a/types/address.go b/types/address.go
@@ -9,9 +9,8 @@ import (
 	"strings"
 	"sync"
 
-	yaml "gopkg.in/yaml.v2"
-
 	"github.com/hashicorp/golang-lru/simplelru"
+	yaml "gopkg.in/yaml.v2"
 
 	cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types"
 	"github.com/cosmos/cosmos-sdk/internal/conv"

diff --git a/types/address/README.md b/types/address/README.md
@@ -1,6 +1,6 @@
 # Account
 
-This package defines Cosmos SDK address related functions.
+This package defines Cosmos SDK address-related functions.
 
 ## References
 

diff --git a/types/address/hash.go b/types/address/hash.go
@@ -13,6 +13,7 @@ import (
 // Len is the length of base addresses
 const Len = sha256.Size
 
+// Addressable represents any type from which we can derive an address.
 type Addressable interface {
 	Address() []byte
 }

diff --git a/types/query/pagination.go b/types/query/pagination.go
@@ -4,11 +4,10 @@ import (
 	"fmt"
 	"math"
 
+	db "github.com/tendermint/tm-db"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 
-	db "github.com/tendermint/tm-db"
-
 	"github.com/cosmos/cosmos-sdk/store/types"
 )
 

diff --git a/types/query/pagination.pb.go b/types/query/pagination.pb.go
diff --git a/types/query/pagination_test.go b/types/query/pagination_test.go
@@ -6,7 +6,6 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/suite"
-
 	tmproto "github.com/tendermint/tendermint/proto/tendermint/types"
 	dbm "github.com/tendermint/tm-db"
-Original file line number
+Diff line change
@@ Expand Up / @@ -41,4 +41,4 @@ message ListImplementationsRequest { @@
     // RPC.
     message ListImplementationsResponse {
       repeated string implementation_message_names = 1;
-    }
+    }