swagger-api / swagger-api/swagger-codegen

Maven plugin skipOverwrite documentation is ambiguous

Aperta
#2,425 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Swagger Codegen Maven Plugin
Lingua principale
Mustache
Stelle
17.8k
Fork
6k
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia individuando la documentazione del plugin Maven per la proprietà skipOverwrite, quindi leggi la relativa implementazione per stabilire cosa fa true e se i timestamp influiscono sulla decisione. Il lavoro è concluso quando la documentazione descrive chiaramente il comportamento e risolve l’ambiguità sollevata nell’issue.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.