Skip to content

Faulty generation of markdown format for data type list #219

@crazymind1337

Description

@crazymind1337

Describe the Bug

We are writing heavily custom data types to validate special hash formats. We are using puppet strings generate --format markdown --out REFERENCES.md for documentation. Our markdown-lint CI test complains about the MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1].

Expected Behavior

Generating a markdown formated REFERENCES.md withtout MD009/no-trailing-spaces issues

Steps to Reproduce

Steps to reproduce the behavior:

  • write a module with a data type in it
  • add the documentation header to the data type file without @summary ...
  • install markdown-lint:
    • npm install -g markdownlint-cli
    • npm install -g markdownlint
  • execute the markdownlint:
    • node_modules/.bin/markdownlint <path_to_markdown_file>

Environment

  • Version: 2.3.1
  • Platform: any (CI: ubuntu-18.04, local: MacOS 10.15.2)

Additional Context

%

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions