[
https://issues.apache.org/jira/browse/ZOOKEEPER-2801?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16044565#comment-16044565
]
ASF GitHub Bot commented on ZOOKEEPER-2801:
-------------------------------------------
Github user tmancill commented on the issue:
https://github.com/apache/zookeeper/pull/275
@hanm Thank you for the information regarding the documentation tool-chain.
I will rework the PR to only modify the document sources. (Although it will
probably be early next week.)
The tool used to find the typos is
[spellintian](https://manpages.debian.org/unstable/lintian/spellintian.1.en.html),
which is part of Debian's [lintian](https://tracker.debian.org/pkg/lintian)
package. It's pretty good at catching some common typos, although certain
types of code documentation trigger false positives for repeated words when the
source is _word punctuation word_. For this PR, I fed the spellintian output
into some `awk` to produce `sed` commands of proposed corrections. Then I
removed the sed commands for the false positives and other edge cases (still a
manual step) and ran the script against the source tree. So it's conceivable
that spellintian could be worked into a commit workflow, although given all of
the moving parts, maybe it fits better as part of a pre-release checklist.
Regarding branch-3.4, https://github.com/apache/zookeeper/pull/174 should
have addressed most of the issues in that branch. `lintian` didn't notice any
typos when I packaged 3.4.10 for Debian.
And for branch-3.5, this patch will apply after dropping a couple of the
hunks. Should I create a separate JIRA and submit a separate PR (once I get
this one correct) ?
> address spelling errors/typos
> -----------------------------
>
> Key: ZOOKEEPER-2801
> URL: https://issues.apache.org/jira/browse/ZOOKEEPER-2801
> Project: ZooKeeper
> Issue Type: Improvement
> Affects Versions: 3.5.3
> Reporter: tony mancill
> Assignee: tony mancill
> Priority: Trivial
>
> This is a follow-on for ZOOKEEPER-2617 (for which I only supplied a patch for
> branch-3.4), that addresses minor typos in master. With a slight
> modification, the patch also applies against the branch-3.5 branch.
> If folks are curious, the typos are spotted with the "spellintian" shipped
> with Debian's lintian package.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
