influxdata / openapi

An OpenAPI specification for influx (cloud/oss) apis.
MIT License
17 stars 10 forks source link

documentation: the opening backtick for a code fence must appear at the start of the line #540

Closed sranka closed 1 year ago

sranka commented 1 year ago

When running a code generation tool (@influxdata/oats v 0.7.0), it reports wrong documentation contrent,

3 backticks must appear at start of the line

/influxdb-client-js/packages/apis/src/generated/types.ts
  1931:3   warning  tsdoc-code-fence-opening-indent: The opening backtick for a code fence must appear at the start of the line                 tsdoc/syntax
  1940:36  warning  tsdoc-malformed-inline-tag: Expecting a TSDoc tag starting with "{@"                                                        tsdoc/syntax
  1940:45  warning  tsdoc-escape-right-brace: The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag  tsdoc/syntax
  1940:48  warning  tsdoc-malformed-inline-tag: Expecting a TSDoc tag starting with "{@"                                                        tsdoc/syntax
  1940:57  warning  tsdoc-escape-right-brace: The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag  tsdoc/syntax
  1940:58  warning  tsdoc-at-sign-in-word: The "@" character looks like part of a TSDoc tag; use a backslash to escape it                       tsdoc/syntax
  1943:3   warning  tsdoc-code-fence-opening-indent: The opening backtick for a code fence must appear at the start of the line                 tsdoc/syntax
  1948:3   warning  tsdoc-code-fence-opening-indent: The opening backtick for a code fence must appear at the start of the line                 tsdoc/syntax
  1949:3   warning  tsdoc-malformed-inline-tag: Expecting a TSDoc tag starting with "{@"                                                        tsdoc/syntax
  1951:16  warning  tsdoc-malformed-inline-tag: Expecting a TSDoc tag starting with "{@"                                                        tsdoc/syntax
  1954:5   warning  tsdoc-escape-right-brace: The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag  tsdoc/syntax
  1956:3   warning  tsdoc-escape-right-brace: The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag  tsdoc/syntax
  1957:3   warning  tsdoc-code-fence-opening-indent: The opening backtick for a code fence must appear at the start of the line                 tsdoc/syntax
  2017:3   warning  tsdoc-code-fence-opening-indent: The opening backtick for a code fence must appear at the start of the line                 tsdoc/syntax
  2018:3   warning  tsdoc-malformed-inline-tag: Expecting a TSDoc tag starting with "{@"                                                        tsdoc/syntax
  2018:13  warning  tsdoc-malformed-inline-tag: Expecting a TSDoc tag starting with "{@"                                                        tsdoc/syntax
  2020:26  warning  tsdoc-malformed-inline-tag: Expecting a TSDoc tag starting with "{@"                                                        tsdoc/syntax
  2023:9   warning  tsdoc-escape-right-brace: The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag  tsdoc/syntax
  2024:5   warning  tsdoc-escape-right-brace: The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag  tsdoc/syntax
  2025:3   warning  tsdoc-escape-right-brace: The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag  tsdoc/syntax
  2026:3   warning  tsdoc-code-fence-opening-indent: The opening backtick for a code fence must appear at the start of the line                 tsdoc/syntax
  2030:3   warning  tsdoc-code-fence-opening-indent: The opening backtick for a code fence must appear at the start of the line                 tsdoc/syntax
  2031:3   warning  tsdoc-malformed-inline-tag: Expecting a TSDoc tag starting with "{@"                                                        tsdoc/syntax
  2031:13  warning  tsdoc-malformed-inline-tag: Expecting a TSDoc tag starting with "{@"                                                        tsdoc/syntax
  2034:50  warning  tsdoc-unnecessary-backslash: A backslash can only be used to escape a punctuation character                                 tsdoc/syntax
  2034:52  warning  tsdoc-unnecessary-backslash: A backslash can only be used to escape a punctuation character                                 tsdoc/syntax
  2037:5   warning  tsdoc-escape-right-brace: The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag  tsdoc/syntax
  2038:3   warning  tsdoc-escape-right-brace: The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag  tsdoc/syntax
  2039:3   warning  tsdoc-code-fence-opening-indent: The opening backtick for a code fence must appear at the start of the line                 tsdoc/syntax

More specifically, the following types from oss.yml contains such backticks that are not aligned with the start of the line.