Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG] Generator options documentation has broken formatting #6074

Closed
4 of 6 tasks
gjbianco opened this issue Apr 27, 2020 · 0 comments · Fixed by #6079
Closed
4 of 6 tasks

[BUG] Generator options documentation has broken formatting #6074

gjbianco opened this issue Apr 27, 2020 · 0 comments · Fixed by #6079

Comments

@gjbianco
Copy link

Bug Report Checklist

  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • What's the version of OpenAPI Generator used?
  • Have you search for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Bounty to sponsor the fix (example)
Description

The Markdown formatting is broken in a lot of the generator options' documentation. It looks like the way legacyDiscriminatorBehavior was added broke the table of options.

For example, the typescript-axios generator: https://openapi-generator.tech/docs/generators/typescript-axios/

It also shows up incorrectly even in the GFM preview of the Markdown file: https://github.com/spacether/openapi-generator/blob/f8c95d8865e0a4a7a2e3dc1b20a3c909f0205ca6/docs/generators/typescript-axios.md

openapi-generator version

Latest code available on master

OpenAPI declaration file content or url

N/A

Command line used for generation

N/A

Steps to reproduce
  1. Visit either https://openapi-generator.tech/docs/generators/typescript-axios/ or https://github.com/spacether/openapi-generator/blob/f8c95d8865e0a4a7a2e3dc1b20a3c909f0205ca6/docs/generators/typescript-axios.md (amongst others).
  2. Look at the options after legacyDiscriminatorBehavior.
Related issues/PRs

This appears to have been introduced as part of #4906

Suggest a fix

The author tried to nest a list inside the table, which it appears (most?) flavors of Markdown do not support. At the very least, it doesn't work the way it is written in GFM as well as whichever flavor is used by the online documentation tooling.

The fix should either involve changing the syntax to fix the bulleted list or removing the list from the table (perhaps use a footnote to add the list at the bottom?).

I am unfamiliar with how options such as those get added to the many different Markdown docs in this project. i.e. was this a manual process or is there a tool that can add common options to several generators at once?

@gjbianco gjbianco changed the title [BUG] Description [BUG] Generator options documentation has broken formatting Apr 27, 2020
@spacether spacether mentioned this issue Apr 27, 2020
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant