You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@flink.apache.org by Zhongpu Chen <ch...@gmail.com> on 2023/02/22 08:42:56 UTC

[jira](FLINK-31177) To introduce a formatter for Markdown files

As I mentioned in FLINK-31177 (
https://issues.apache.org/jira/browse/FLINK-31177):

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.
What do you think?

-- 
Zhongpu Chen