Skip to content

Commit

Permalink
Clean up typo and grammar issues in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
vcschapp committed Jul 22, 2022
1 parent 65ae9cb commit ae05c9c
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 12 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ cloud!

Incite is a native GoLang library that streamlines your interactions with the
CloudWatch Logs Insights API using minimalist, native Go, paradigms. Incite gets
the API out of the way so you can focus on app development.
the API out of the way, so you can focus on app development.

Features
========
Expand Down Expand Up @@ -80,14 +80,14 @@ import (
"fmt"
"time"

"github.com/aws/aws-sdk-go/service/cloudwatchlogs"
"github.com/aws/aws-sdk-go/aws/session"
"github.com/aws/aws-sdk-go/service/cloudwatchlogs"
"github.com/gogama/incite"
)

func main() {
// Use the AWS SDK for Go to get the CloudWatch API actions Incite needs.
// For simplicity we assume that the correct AWS region and credentials are
// For simplicity, we assume that the correct AWS region and credentials are
// already set in the environment.
a := cloudwatchlogs.New(session.Must(session.NewSession()))

Expand Down
2 changes: 1 addition & 1 deletion cloudwatchlogs_actions.go
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ const (
)

// RPSQuotaLimits contains the CloudWatch Logs service quota limits for
// number of requests per second for each CloudWatch Logs API act
// number of requests per second for each CloudWatch Logs API action
// before the request fails due to a throttling error as documented in
// the AWS service limits system.
//
Expand Down
2 changes: 1 addition & 1 deletion example_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ func ExampleUnmarshal_mapStringInterface() {
// As a special case, the data are unmarshalled fuzzily if the target
// is a map[string]interface{}. If a value is valid JSON it is
// unmarshalled as JSON, otherwise it is kept as a string. Here the
// Object and QuotedString fields are contain valid JSON so they
// Object and QuotedString fields contain valid JSON so they
// unmarshal as a map and string, respectively. UnquotedString is
// not valid JSON and stays as a string.
data := []incite.Result{
Expand Down
2 changes: 1 addition & 1 deletion log.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ package incite
// A Logger represents a logging object which can receive log messages
// from a QueryManager and send them to an output sink.
//
// Logger is compatible with *log.Logger. Therefore you may, for
// Logger is compatible with *log.Logger. Therefore, you may, for
// example, use log.DefaultLogger(), or any other *log.Logger value, as
// the Logger field of a Config structure when constructing a new
// QueryManager using the NewQueryManager function.
Expand Down
2 changes: 1 addition & 1 deletion mgr_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1718,7 +1718,7 @@ func TestQueryManager_Query(t *testing.T) {
},
}

// Run the sub-tests.
// Run the subtests.
for _, testCase := range testCases {
t.Run(testCase.name, func(t *testing.T) {
// ARRANGE.
Expand Down
2 changes: 1 addition & 1 deletion query.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ package incite

import "context"

// Query is sweet sweet sugar to perform a synchronous CloudWatch Logs
// Query is sweet, sweet sugar to perform a synchronous CloudWatch Logs
// Insights query and get back all the results without needing to
// construct a QueryManager. Query runs the query indicated by q, using
// the CloudWatch Logs actions provided by a, and returns all the
Expand Down
8 changes: 4 additions & 4 deletions unmarshal.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ import (
// target a struct field unmarshallable type, an InvalidUnmarshalError
// is returned.
//
// • A struct field with a "json" tag receives the the value of the
// • A struct field with a "json" tag receives the value of the
// ResultField field named in the tag using the json.Unmarshal function
// from the encoding/json package with the ResultField value as the
// input JSON and the struct field address as the target. If the tag is
Expand All @@ -62,7 +62,7 @@ import (
// • A struct field with no "incite" or "json" tag receives the value
// of the ResultField field sharing the same case-sensitive name as the
// struct field, but only if the field type ultimately targets a
// struct field unmarshallable type. Otherwise the field is ignored.
// struct field unmarshallable type. Otherwise, the field is ignored.
//
// The following types are considered struct field unmarshallable types:
//
Expand All @@ -88,7 +88,7 @@ import (
// InvalidUnmarshalError.
//
// If a result field value cannot be decoded, Unmarshal continues
// decoding the remaining input data on a best effort basis, and after
// decoding the remaining input data on a best-effort basis, and after
// processing all the data, returns an UnmarshalResultFieldValueError
// describing the first such decoding problem encountered.
//
Expand Down Expand Up @@ -571,7 +571,7 @@ func copyResult(r Result) Result {
}

// An InvalidUnmarshalError occurs when a value with an invalid type
// is passed to to Unmarshal.
// is passed to Unmarshal.
type InvalidUnmarshalError struct {
Type reflect.Type
RowType reflect.Type
Expand Down

0 comments on commit ae05c9c

Please sign in to comment.