[
https://issues.apache.org/jira/browse/FLINK-31177?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17692020#comment-17692020
]
Martijn Visser commented on FLINK-31177:
----------------------------------------
[~zhongpu314] Please open a discussion thread on the Dev mailing list for a
topic like this, especially taking
https://flink.apache.org/contributing/contribute-documentation.html and
https://flink.apache.org/contributing/docs-style.html into account.
> To introduce a formatter for Markdown files
> -------------------------------------------
>
> Key: FLINK-31177
> URL: https://issues.apache.org/jira/browse/FLINK-31177
> Project: Flink
> Issue Type: Improvement
> Reporter: CHEN Zhongpu
> Priority: Minor
>
> Currently, markdown files in *docs* are maintained and updated by many
> contributors, and different people have varying code style taste. By the way,
> as the syntax of markdown is not really strict, the styles tend to be
> inconsistent.
> To name a few,
> * Some prefer `*` to make a list item, while others may prefer `-`.
> * It is common to leave many unnecessary blank lines and spaces.
> * To make a divider, the number of `-` can be varying.
> To this end, I think it would be nicer to encourage or demand contributors to
> format their markdown files before making a pull request. Personally, I
> think Prettier ([https://prettier.io/)] is a good candidate.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
