swagger-api / swagger-api/swagger-codegen
[Python] The generated README.md file has missing new lines
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
The generated README.md file has missing new lines. The document is unreadable.
The README.md file: https://github.com/greenpau/py_insightvm_sdk/blob/bbc2485fb1196d4a000bf199aecef7dcb890a7c8/README.md
Code base: https://github.com/greenpau/py_insightvm_sdk
OpenAPI JSON: https://github.com/greenpau/py_insightvm_sdk/blob/master/assets/openapi.json
Swagger-codegen version
2.4.2-SNAPSHOT
https://github.com/greenpau/py_insightvm_sdk/blob/master/.swagger-codegen/VERSION
Swagger declaration file content or url
Code base: https://github.com/greenpau/py_insightvm_sdk
Command line used for generation
https://github.com/greenpau/py_insightvm_sdk/blob/master/Makefile#L22-L27
Steps to reproduce
git clone https://github.com/greenpau/py_insightvm_sdk.git
cd py_insightvm_sdk
make openapi
Related issues/PRs
None.
Suggest a fix/enhancement
N/A.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the generation command in Makefile lines 22-27, then compare the generated README.md at the reported commit with the assets/openapi.json input. Trace which Swagger Codegen template or entry point controls README formatting. Done means running make openapi produces a readable README.md with the expected new lines.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, python
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100