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

Posted to dev@flink.apache.org by "CHEN Zhongpu (Jira)" <ji...@apache.org> on 2023/02/22 06:56:00 UTC

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

CHEN Zhongpu created FLINK-31177:
------------------------------------

             Summary: 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


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 can also 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)