[
https://issues.apache.org/jira/browse/FLINK-23044?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Huang Yu updated FLINK-23044:
-----------------------------
Description:
using [codetypo|[https://www.github.com/raywill/codetypo]] I found tons of
typos in Flink documents.
{color:#505f79}[xiaochu.yh ~/tools/codetypo] (main) $python checker.py
flink/docs/{color}
{color:#505f79}flink/docs/README.md{color}
{color:#505f79} ommitted (suggestion: omitted){color}
{color:#505f79} groupd (suggestion: group){color}
{color:#505f79} artfiact (suggestion: artifact){color}
{color:#505f79} sometab (suggestion: sometag){color}
{color:#505f79} verison (suggestion: verion){color}
{color:#505f79} pgenerate (suggestion: generate){color}
{color:#505f79} harnesses (suggestion: harnessed){color}
{color:#505f79} flavored (suggestion: favored){color}
{color:#505f79} shortcode (suggestion: sortcode){color}
{color:#505f79} flinks (suggestion: blinks){color}
{color:#505f79}flink/docs/assets/github.css{color}
{color:#505f79} lntable (suggestion: ntable){color}
{color:#505f79} affix (suggestion: affin){color}
{color:#505f79} ffffcc (suggestion: fffcc){color}
{color:#505f79} subheading (suggestion: subheadings){color}
{color:#505f79}flink/docs/assets/_fonts.scss{color}
{color:#505f79} lucida (suggestion: lucina){color}
{color:#505f79} arial (suggestion: ariel){color}
{color:#505f79}flink/docs/layouts/partials/docs/simple-title.html{color}
{color:#505f79} sytling (suggestion: styling){color}
{color:#505f79}flink/docs/layouts/partials/docs/inject/menu-after.html{color}
{color:#505f79} dictonary (suggestion: dictionary){color}
{color:#505f79}flink/docs/layouts/shortcodes/version.html{color}
{color:#505f79} parmeters (suggestion: pameters){color}
{color:#505f79} shortcode (suggestion: sortcode){color}
{color:#505f79}flink/docs/layouts/shortcodes/beta.html{color}
{color:#505f79} guaruntees (suggestion: guarantees){color}
{color:#505f79}flink/docs/layouts/shortcodes/stable.html{color}
{color:#505f79} parmeters (suggestion: pameters){color}
{color:#505f79} shortcode (suggestion: sortcode){color}
{color:#505f79} {color}
Some false alarm, some are real typos which need to be fixed.
Codetypo can also check code typos. I just have no time to run over it.
was:
using [codetypo|[https://www.github.com/raywill/codetypo]] I found tons of
typos in Flink documents.
[xiaochu.yh ~/tools/codetypo] (main) $python checker.py flink/docs/
flink/docs/README.md
ommitted (suggestion: omitted)
groupd (suggestion: group)
artfiact (suggestion: artifact)
sometab (suggestion: sometag)
verison (suggestion: verion)
pgenerate (suggestion: generate)
harnesses (suggestion: harnessed)
flavored (suggestion: favored)
shortcode (suggestion: sortcode)
flinks (suggestion: blinks)
flink/docs/assets/github.css
lntable (suggestion: ntable)
affix (suggestion: affin)
ffffcc (suggestion: fffcc)
subheading (suggestion: subheadings)
flink/docs/assets/_fonts.scss
lucida (suggestion: lucina)
arial (suggestion: ariel)
flink/docs/layouts/partials/docs/simple-title.html
sytling (suggestion: styling)
flink/docs/layouts/partials/docs/inject/menu-after.html
dictonary (suggestion: dictionary)
flink/docs/layouts/shortcodes/version.html
parmeters (suggestion: pameters)
shortcode (suggestion: sortcode)
flink/docs/layouts/shortcodes/beta.html
guaruntees (suggestion: guarantees)
flink/docs/layouts/shortcodes/stable.html
parmeters (suggestion: pameters)
shortcode (suggestion: sortcode)
```
some of them are real typos which need to be fixed.
Codetypo can also check code typos. I just have no time to run over it.
> fix typos in docs
> -----------------
>
> Key: FLINK-23044
> URL: https://issues.apache.org/jira/browse/FLINK-23044
> Project: Flink
> Issue Type: Improvement
> Components: Documentation
> Reporter: Huang Yu
> Priority: Minor
> Labels: typo
> Fix For: 1.14.0
>
> Original Estimate: 1h
> Remaining Estimate: 1h
>
> using [codetypo|[https://www.github.com/raywill/codetypo]] I found tons of
> typos in Flink documents.
>
>
> {color:#505f79}[xiaochu.yh ~/tools/codetypo] (main) $python checker.py
> flink/docs/{color}
> {color:#505f79}flink/docs/README.md{color}
> {color:#505f79} ommitted (suggestion: omitted){color}
> {color:#505f79} groupd (suggestion: group){color}
> {color:#505f79} artfiact (suggestion: artifact){color}
> {color:#505f79} sometab (suggestion: sometag){color}
> {color:#505f79} verison (suggestion: verion){color}
> {color:#505f79} pgenerate (suggestion: generate){color}
> {color:#505f79} harnesses (suggestion: harnessed){color}
> {color:#505f79} flavored (suggestion: favored){color}
> {color:#505f79} shortcode (suggestion: sortcode){color}
> {color:#505f79} flinks (suggestion: blinks){color}
> {color:#505f79}flink/docs/assets/github.css{color}
> {color:#505f79} lntable (suggestion: ntable){color}
> {color:#505f79} affix (suggestion: affin){color}
> {color:#505f79} ffffcc (suggestion: fffcc){color}
> {color:#505f79} subheading (suggestion: subheadings){color}
> {color:#505f79}flink/docs/assets/_fonts.scss{color}
> {color:#505f79} lucida (suggestion: lucina){color}
> {color:#505f79} arial (suggestion: ariel){color}
> {color:#505f79}flink/docs/layouts/partials/docs/simple-title.html{color}
> {color:#505f79} sytling (suggestion: styling){color}
> {color:#505f79}flink/docs/layouts/partials/docs/inject/menu-after.html{color}
> {color:#505f79} dictonary (suggestion: dictionary){color}
> {color:#505f79}flink/docs/layouts/shortcodes/version.html{color}
> {color:#505f79} parmeters (suggestion: pameters){color}
> {color:#505f79} shortcode (suggestion: sortcode){color}
> {color:#505f79}flink/docs/layouts/shortcodes/beta.html{color}
> {color:#505f79} guaruntees (suggestion: guarantees){color}
> {color:#505f79}flink/docs/layouts/shortcodes/stable.html{color}
> {color:#505f79} parmeters (suggestion: pameters){color}
> {color:#505f79} shortcode (suggestion: sortcode){color}
> {color:#505f79} {color}
>
> Some false alarm, some are real typos which need to be fixed.
> Codetypo can also check code typos. I just have no time to run over it.
>
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
