swagger-api / swagger-api/swagger-codegen
Maven plugin skipOverwrite documentation is ambiguous
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Mustache
- Sterne
- 17.8k
- Forks
- 6k
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
The skipOverwrite property is documented as follows: "Specifies if the existing files should be overwritten during the generation."
Apart from being grammatically incorrect (use of 'if' incorrect; should be 'whether'), it's unclear whether a value of true would or would not overwrite existing files. It's also unclear whether the check takes account of whether the generated files are up to date timestamp-wise with respect to the source YAML/JSON.
If the property does not take account of up-to-date-ness, then I can't see what use it is and I can't see why it isn't just called 'skip' like every other Maven plug-in. If the property does take account of up-to-date-ness, then I can't see why it is necessary in the first place.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die Maven-Plugin-Dokumentation für die Eigenschaft skipOverwrite zu finden, und lies anschließend deren Implementierung, um festzustellen, was true bewirkt und ob Zeitstempel die Entscheidung beeinflussen. Als abgeschlossen gilt die Aufgabe, wenn die Dokumentation das Verhalten eindeutig beschreibt und die im Issue aufgeworfene Unklarheit klärt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 25/100