diff --git a/.words b/.words index 63fba00c1..24be7f625 100644 --- a/.words +++ b/.words @@ -1,26 +1,9 @@ 1 -## ^^^ size estimate, just needs to be non-zero -## -## The .words file is used by gospel (v1.2+), which wraps the Hunspell libraries but populates the dictionary with identifiers from the Go source. -## -## -## Comment lines are not actually parsed as comments, try to be careful ... but in practice they seem to work? -## -## We assume en_US hunspell dictionaries are installed and used. The /AFFIXRULES are defined in en_US.aff (eg: /usr/share/hunspell/en_US.aff) -## -## words which are in the base dictionary can't have extra affix rules added to them, so we have to start with the affixed variant we want to add. -## thus creds rather than cred/S and so on -## So we can't use receive/DRSZGBU, adding 'U', to allow unreceive and variants, we have to use unreceive as the stem. -## We can't define our own affix or compound rules, to capture rfc\d{3,} or 0x[0-9A-Fa-f]{2} - -## People involved who are referenced in todo/fixmes + derek dlc ivan -## Legitimate spellings in non-US English dialects; -## regular-if-rarer words just missing from the dictionary; -## variants of words not covered by hunspell en_US rules. acknowledgement/SM arity deduplication/S @@ -31,31 +14,12 @@ observable/S redelivery/S retransmitting retry/SB -unmarshal/SDG - -# I think that retry, being added as a symbol, is precluding the re-addition here with affix rules, -# so "retry/SB" above is ignored -retries -retryable - -## Things gospel doesn't pick up, but doesn't yet; I've filed -## Eg, plurals of non-collection types, or wire-format encodings in a struct field's tag -AsyncSubscriptions -ChanSubscriptions -PubAckFutures -SubOpts -SyncSubscriptions -no_wait - -## Conceptual nouns not actually in the source, describing state + SlowConsumer -## Symbols from elsewhere referred to in comments but not referenced in the code, so not currently surfaced by gospel as acceptable AppendInt ReadMIMEHeader -## The rest - clientProtoZero jetstream v1 @@ -83,8 +47,6 @@ tm todo unsub/S -## The spelling tokenizer doesn't take "permessage-deflate" as allowing for ... "permessage-deflate", -## which is an RFC7692 registered extension. We have to explicitly list "permessage". permessage permessage-deflate urlA diff --git a/.words.readme b/.words.readme new file mode 100644 index 000000000..9d9f5cbbc --- /dev/null +++ b/.words.readme @@ -0,0 +1,25 @@ +The .words file is used by gospel (v1.2+), which wraps the Hunspell libraries +but populates the dictionary with identifiers from the Go source. + + + +Alas, no comments are allowed in the .words file and newer versions of gospel +error out on seeing them. This is really a hunspell restriction. + +We assume en_US hunspell dictionaries are installed and used. +The /AFFIXRULES are defined in en_US.aff (eg: /usr/share/hunspell/en_US.aff) +Invoke `hunspell -D` to see the actual locations. + +Words which are in the base dictionary can't have extra affix rules added to +them, so we have to start with the affixed variant we want to add. +Thus `creds` rather than `cred/S` and so on. + +So we can't use receive/DRSZGBU, adding 'U', to allow unreceive and variants, +we have to use unreceive as the stem. + +We can't define our own affix or compound rules, +to capture rfc\d{3,} or 0x[0-9A-Fa-f]{2} + +The spelling tokenizer doesn't take "permessage-deflate" as allowing for ... +"permessage-deflate", which is an RFC7692 registered extension for websockets. +We have to explicitly list "permessage". diff --git a/js.go b/js.go index 4013a975e..1259743ec 100644 --- a/js.go +++ b/js.go @@ -851,7 +851,7 @@ func RetryWait(dur time.Duration) PubOpt { }) } -// RetryAttempts sets the retry number of attemopts when ErrNoResponders is encountered. +// RetryAttempts sets the retry number of attempts when ErrNoResponders is encountered. func RetryAttempts(num int) PubOpt { return pubOptFn(func(opts *pubOpts) error { opts.rnum = num