Skip to content

Commit

Permalink
fix: update comments
Browse files Browse the repository at this point in the history
Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
  • Loading branch information
JeyJeyGao committed Sep 26, 2022
1 parent c65f5c6 commit 94cce6a
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion signature/jws/jws.go
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ func mergeMaps(maps ...map[string]interface{}) (map[string]interface{}, error) {
}

// compactJWS converts Flattened JWS JSON Serialization Syntax (section-7.2.2) to
// JWS Compact Serialization (section-7.1)
// JWS Compact Serialization (section-7.1).
//
// [RFC 7515]: https://www.rfc-editor.org/rfc/rfc7515.html
func compactJWS(envelope *jwsEnvelope) string {
Expand Down
2 changes: 1 addition & 1 deletion signature/jws/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const (
headerKeyAuthenticSigningTime = "io.cncf.notary.authenticSigningTime"
)

// headerKeys includes all system aware keys for JWS protected header
// headerKeys includes all system aware keys for JWS protected header.
// [JWS envelope]: https://github.com/notaryproject/notaryproject/blob/main/signature-envelope-jws.md#protected-headers
var headerKeys = []string{
headerKeyAlg,
Expand Down
4 changes: 2 additions & 2 deletions signature/signaturetest/algorithm.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ package signaturetest

import "github.com/notaryproject/notation-core-go/signature"

// KeyTypes contains supported key type
// KeyTypes contains supported key type.
var KeyTypes = []signature.KeyType{signature.KeyTypeRSA, signature.KeyTypeEC}

// GetKeySizes returns the supported key size for the named keyType
// GetKeySizes returns the supported key size for the named keyType.
func GetKeySizes(keyType signature.KeyType) []int {
switch keyType {
case signature.KeyTypeRSA:
Expand Down
2 changes: 1 addition & 1 deletion signature/signaturetest/signer.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
"github.com/notaryproject/notation-core-go/testhelper"
)

// GetTestLocalSigner returns the local signer with given keyType and size for testing
// GetTestLocalSigner returns the local signer with given keyType and size for testing.
func GetTestLocalSigner(keyType signature.KeyType, size int) (signature.Signer, error) {
switch keyType {
case signature.KeyTypeEC:
Expand Down

0 comments on commit 94cce6a

Please sign in to comment.