Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spelling - comments #7492

Merged
merged 1 commit into from
May 14, 2020
Merged

Spelling - comments #7492

merged 1 commit into from
May 14, 2020

Conversation

jsoref
Copy link
Contributor

@jsoref jsoref commented May 10, 2020

Misspellings identified by the check-spelling action.

Required for all PRs:

  • Signed CLA.

  • Associated README.md updated. -- I'm going to wait for someone to review this before I take this step. Note that CONTRIBUTING.md makes no mention of this.

  • Has appropriate unit tests. -- Not included, but available (note that it wouldn't be a make thing, although I suppose I could create a Docker for it... that seems pretty doable -- people have asked for a way to do that...):

    It reported: jsoref@25d89f6#commitcomment-39074475

    And it validated that the changes in this PR made it happy: jsoref@95180ce


Some projects like to rebase, some to squash, some ask for things to be split up. I try to avoid doing anything until a reviewer provides direction. It's much easier for me to initially work with individual commits (e.g. there are some en-US commits here, if you tell me your project is en-GB, I can easily drop them today, but if I squash eagerly, then disentangling them can be painful). I'm happy to make changes/follow directions within reason.

@@ -256,7 +256,7 @@
# specify address via a url matching:
# postgres://[pqgotest[:password]]@localhost[/dbname]?sslmode=[disable|verify-ca|verify-full]
# or a simple string:
# host=localhost user=pqotest password=... sslmode=... dbname=app_production
# host=localhost user=pqgotest password=... sslmode=... dbname=app_production
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not 100% confident about this

@@ -743,7 +743,7 @@
# template = "host.tags.measurement.field"
# ## Timeout in seconds to connect
# timeout = "2s"
# ## Display Communcation to Instrumental
# ## Display Communication to Instrumental
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

?

@@ -939,7 +939,7 @@

# # Configuration for Librato API to send metrics to.
# [[outputs.librato]]
# ## Librator API Docs
# ## Librato API Docs
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pretty confident

@@ -130,7 +130,7 @@ func (c *ServerConfig) TLSConfig() (*tls.Config, error) {

if tlsConfig.MinVersion != 0 && tlsConfig.MaxVersion != 0 && tlsConfig.MinVersion > tlsConfig.MaxVersion {
return nil, fmt.Errorf(
"tls min version %q can't be greater then tls max version %q", tlsConfig.MinVersion, tlsConfig.MaxVersion)
"tls min version %q can't be greater than tls max version %q", tlsConfig.MinVersion, tlsConfig.MaxVersion)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was a "mass" change greater then (Google Chrome even complains about this in this comment field) => greater than. I didn't initially check for less then -- there's one instance of that as well.

@@ -97,7 +97,7 @@ func TestFilter_Empty(t *testing.T) {
"foo_bar",
"foo.bar",
"foo-bar",
"supercalifradjulisticexpialidocious",
"supercalifragilisticexpialidocious",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Google Sheets made this correction...

plugins/inputs/pf/pf_test.go Outdated Show resolved Hide resolved
plugins/inputs/smart/smart_test.go Outdated Show resolved Hide resolved
@@ -2606,7 +2606,7 @@ VALUES (N'QDS_SHUTDOWN_QUEUE'), (N'HADR_FILESTREAM_IOMGR_IOCOMPLETION'),
(N'DIRTY_PAGE_POLL'), (N'DISPATCHER_QUEUE_SEMAPHORE'),
(N'EXECSYNC'), (N'FSAGENT'),
(N'FT_IFTS_SCHEDULER_IDLE_WAIT'), (N'FT_IFTSHC_MUTEX'),
(N'HADR_CLUSAPI_CALL'), (N'HADR_FILESTREAM_IOMGR_IOCOMPLETIO(N'),
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

??

@@ -135,7 +135,7 @@ func defaultVSphere() *VSphere {
VMInclude: []string{"/**"},
DatastoreMetricInclude: []string{
"disk.used.*",
"disk.provsioned.*"},
"disk.provisioned.*"},
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Worrying

@@ -17,7 +17,7 @@ import (
)

var (
registry *rgstry
registry *Registry
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change should be ok as registry Registry differs in case (unlike the earlier TimeSeries which didn't...)

@@ -234,7 +234,7 @@ func (c *FakeConsumerGroupClaim) InitialOffset() int64 {
panic("not implemented")
}

func (c *FakeConsumerGroupClaim) HighWaterMarkOffset() int64 {
func (c *FakeConsumerGroupClaim) HiWaterMarkOffset() int64 {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm dropping this (as cg.ConsumeClaim uses HighWaterMarkOffset).

The reason for the change is that this repository mostly uses hiwater, e.g. hiwater_bytes and lowater_bytes, but as this is an API thing from an upstream, it's just one of those inconsistencies that a project will have.

(The other fun ones are marshal/marshall -- this project is almost entirely in the former, and I'm trying to make that consistent and falsy/falsey -- neither of which are used by this project.)

@@ -1159,7 +1159,7 @@ func (e *Endpoint) collectChunk(ctx context.Context, pqs queryChunk, res *resour
}
count++

// Update highwater marks
// Update hiwater marks
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the normal hiwater item. I'm also fine with writing out high water or dropping this change. highwater is just inconsistent with the naming style of the variables.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It really doesn't matter. :)

@jsoref
Copy link
Contributor Author

jsoref commented May 11, 2020

I have no idea what happened here. I don't think my changes caused this. And I don't understand how it could happen.

https://app.circleci.com/pipelines/github/influxdata/telegraf/283/workflows/16dfcd82-dfbd-4bbe-81bb-37d1c9de95a4/jobs/54581/parallel-runs/0/steps/0-103

--- FAIL: TestAlignedTicker (0.01s)
    tick_test.go:44: 
        	Error Trace:	tick_test.go:44
        	Error:      	Not equal: 
        	            	expected: []time.Time{time.Time{wall:0x0, ext:62135596810, loc:(*time.Location)(nil)}, time.Time{wall:0x0, ext:62135596820, loc:(*time.Location)(nil)}, time.Time{wall:0x0, ext:62135596830, loc:(*time.Location)(nil)}, time.Time{wall:0x0, ext:62135596840, loc:(*time.Location)(nil)}, time.Time{wall:0x0, ext:62135596850, loc:(*time.Location)(nil)}, time.Time{wall:0x0, ext:62135596860, loc:(*time.Location)(nil)}}
        	            	actual  : []time.Time{time.Time{wall:0x0, ext:62135596810, loc:(*time.Location)(nil)}, time.Time{wall:0x0, ext:62135596820, loc:(*time.Location)(nil)}, time.Time{wall:0x0, ext:62135596830, loc:(*time.Location)(nil)}, time.Time{wall:0x0, ext:62135596840, loc:(*time.Location)(nil)}}
        	            	
        	            	Diff:
        	            	--- Expected
        	            	+++ Actual
        	            	@@ -1,2 +1,2 @@
        	            	-([]time.Time) (len=6) {
        	            	+([]time.Time) (len=4) {
        	            	  (time.Time) 1970-01-01 00:00:10 +0000 UTC,
        	            	@@ -4,5 +4,3 @@
        	            	  (time.Time) 1970-01-01 00:00:30 +0000 UTC,
        	            	- (time.Time) 1970-01-01 00:00:40 +0000 UTC,
        	            	- (time.Time) 1970-01-01 00:00:50 +0000 UTC,
        	            	- (time.Time) 1970-01-01 00:01:00 +0000 UTC
        	            	+ (time.Time) 1970-01-01 00:00:40 +0000 UTC
        	            	 }
        	Test:       	TestAlignedTicker
FAIL
FAIL	github.com/influxdata/telegraf/agent	0.184s

Copy link
Contributor

@danielnelson danielnelson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the pull request. Could you split this into at least two PRs, one for documentation/comments and one that makes changes to code?

Test failure looks like an issue with unrelated new code.

etc/telegraf.conf Outdated Show resolved Hide resolved
@@ -1159,7 +1159,7 @@ func (e *Endpoint) collectChunk(ctx context.Context, pqs queryChunk, res *resour
}
count++

// Update highwater marks
// Update hiwater marks
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It really doesn't matter. :)

@jsoref
Copy link
Contributor Author

jsoref commented May 12, 2020

Sure. Probably tonight.

* accepted
* achieve
* additional
* aggregate
* append
* appropriate
* arithmetic
* assignment
* assumption
* attempts
* available
* bandwidth
* beyond
* character
* collection
* commands
* communication
* compatibility
* compilation
* configuration
* connection
* connections
* conversion
* converts
* correctly
* corresponds
* database
* deletes
* depending
* descend
* descriptor
* directories
* dynamically
* effectively
* efficient
* efficiently
* elasticsearch
* entity
* environment
* exclude
* existing
* explicit
* following
* govmomi
* greater
* grouping
* histogram
* hiwater
* hyphen
* implementation
* independently
* indicates
* interpret
* johnrengelman
* librato
* machinery
* maintains
* measurement
* metadata
* metric
* mix
* mutual
* number
* obfuscated
* output
* outputs
* outputting
* overridable
* overridden
* parameter
* particular
* partition
* performed
* permissions
* persisted
* persistent
* pgmajfault
* pierref
* platform
* plugin
* possible
* postgresql
* pqgotest
* precision
* processors
* prominent
* property
* receive
* received
* recommended
* registered
* registry
* reproduces
* response
* restricted
* restrictive
* retrieve
* retrieves
* retrieving
* returned
* salesforce
* separate
* separator
* snmptranslate
* source
* specified
* splunkmetric
* string
* substructure
* supported
* synthetic
* technique
* telegraf
* timeout
* titilambert
* totals
* translation
* transparent
* unexpected
* uninitialized
* unmarshal
* unnecessary
* unparseable
* unrecognized
* unsupported
* utilization
* without
* zfetchstats
@jsoref jsoref changed the title Spelling Spelling comments May 13, 2020
@jsoref jsoref changed the title Spelling comments Spelling - comments May 13, 2020
@jsoref
Copy link
Contributor Author

jsoref commented May 13, 2020

@danielnelson: ok, this is now just the comments/docs:

134 files changed, 215 insertions(+), 215 deletions(-)

I'm leaving a branch with roughly the original changes here: https://github.com/jsoref/telegraf/tree/spelling-full so that diffs can be made.

remaining changes

47 files changed, 91 insertions(+), 91 deletions(-)

I'm not sure it's worth splitting this. I can probably split this once or twice more, but there's a diminishing returns cost for me.

tests v code

There's at least one change which spans tests/code, so this isn't a viable split.

plugins v main

This split is viable, but mostly because main is so small.

plugins

40 files changed, 78 insertions(+), 78 deletions(-)

main

5 files changed, 11 insertions(+), 11 deletions(-)

@danielnelson danielnelson merged commit 2c56d6d into influxdata:master May 14, 2020
@danielnelson danielnelson added the docs Issues related to Telegraf documentation and configuration descriptions label May 14, 2020
@danielnelson danielnelson added this to the 1.15.0 milestone May 14, 2020
@jsoref jsoref deleted the spelling branch May 14, 2020 09:04
@jsoref jsoref mentioned this pull request May 14, 2020
3 tasks
rhajek pushed a commit to bonitoo-io/telegraf that referenced this pull request Jul 13, 2020
idohalevi pushed a commit to idohalevi/telegraf that referenced this pull request Sep 29, 2020
arstercz pushed a commit to arstercz/telegraf that referenced this pull request Mar 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues related to Telegraf documentation and configuration descriptions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants