[
https://issues.apache.org/jira/browse/SPARK-54895?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jacek Laskowski updated SPARK-54895:
------------------------------------
Summary: [SDP][DOCS] Fix markdown issues in Spark Declarative Pipelines
Programming Guide (was: [SDP][DOCS] Fix markdown issues in
declarative-pipelines-programming-guide.md)
> [SDP][DOCS] Fix markdown issues in Spark Declarative Pipelines Programming
> Guide
> --------------------------------------------------------------------------------
>
> Key: SPARK-54895
> URL: https://issues.apache.org/jira/browse/SPARK-54895
> Project: Spark
> Issue Type: Improvement
> Components: Declarative Pipelines, Documentation
> Affects Versions: 4.2.0
> Reporter: Jacek Laskowski
> Priority: Minor
>
> Executing a Markdown linter {{rumdl check
> declarative-pipelines-programming-guide.md}} gives 32 formatting issues (that
> seem fairly easy to fix, with 9 that can be fixed automatically by the tool).
> {noformat}
> ❯ rumdl check declarative-pipelines-programming-guide.md
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:12:1:
> [MD009] Empty line has trailing spaces [*]
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:13:1:
> [MD046] Use fenced code blocks [*]
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:14:1:
> [MD009] Empty line has trailing spaces [*]
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:22:1:
> [MD004] List marker '*' does not match expected style '-' [*]
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:27:121:
> [MD013] Line length 302 exceeds 120 characters
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:30:1:
> [MD032] List should be preceded by blank line [*]
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:34:121:
> [MD013] Line length 214 exceeds 120 characters
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:42:1:
> [MD040] Code block (```) missing language [*]
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:52:121:
> [MD013] Line length 225 exceeds 120 characters
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:61:121:
> [MD013] Line length 133 exceeds 120 characters
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:65:121:
> [MD013] Line length 165 exceeds 120 characters
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:67:121:
> [MD013] Line length 206 exceeds 120 characters
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:68:121:
> [MD013] Line length 135 exceeds 120 characters
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:69:121:
> [MD013] Line length 266 exceeds 120 characters
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:73:121:
> [MD013] Line length 307 exceeds 120 characters
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:77:121:
> [MD013] Line length 171 exceeds 120 characters
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:81:121:
> [MD013] Line length 124 exceeds 120 characters
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:86:121:
> [MD013] Line length 127 exceeds 120 characters
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:104:121:
> [MD013] Line length 149 exceeds 120 characters
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:110:121:
> [MD013] Line length 190 exceeds 120 characters
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:114:121:
> [MD013] Line length 180 exceeds 120 characters
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:120:121:
> [MD013] Line length 168 exceeds 120 characters
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:122:1:
> [MD004] List marker '*' does not match expected style '-' [*]
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:123:1:
> [MD004] List marker '*' does not match expected style '-' [*]
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:127:121:
> [MD013] Line length 195 exceeds 120 characters
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:128:1:
> [MD032] List should be preceded by blank line [*]
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:144:121:
> [MD013] Line length 140 exceeds 120 characters
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:170:121:
> [MD013] Line length 134 exceeds 120 characters
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:181:121:
> [MD013] Line length 122 exceeds 120 characters
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:232:121:
> [MD013] Line length 125 exceeds 120 characters
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:456:121:
> [MD013] Line length 203 exceeds 120 characters
> /Users/jacek/oss/spark/docs/declarative-pipelines-programming-guide.md:459:121:
> [MD013] Line length 141 exceeds 120 characters
> Issues: Found 32 issues in 1 file (32ms)
> Run `rumdl fmt` to automatically fix 9 of the 32 issues
> {noformat}
> Let's fix them and create a precedent for the other markdown files to be
> fixed (likely as a series of Good First Issues PRs).
>
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
