swagger-api / swagger-api/swagger-codegen
Missing reference in swagger-codegen-maven-plugin README
Open
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
The README of swagger-codegen-maven-plugin has the following line:
configOptions- a map of language-specific parameters (see below)
, but configOptions is not mentioned below as indicated.
Swagger-codegen version
Master
Suggest a fix/enhancement
Is this copied from another README? Perhaps that other README should be linked instead.
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
Open the swagger-codegen-maven-plugin README and locate the configOptions sentence. Check the surrounding section and any related README it may have been copied from, then either add the missing configOptions reference or link to the relevant documentation. Done means the README no longer points to an absent section and the reference is clear.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100