apache / apache/maven-changes-plugin

[MCHANGES-257] Improve filter documentation

Aperta
#542 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
enhancement priority:minor
Lingua principale
Java
Stelle
15
Fork
22
Merge medio
8h 1m
PR unite (30g)
3

Descrizione

**[Sebb](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=sebb@apache.org)** opened **[MCHANGES-257](https://issues.apache.org/jira/browse/MCHANGES-257?redirect=false)** and commented

[1] http://maven.apache.org/plugins/maven-changes-plugin/jira-report-mojo.html#filter
and
[2] http://maven.apache.org/plugins/maven-changes-plugin/examples/customizing-jira-report.html#Using_JIRA_syntax

[1] says:

> The filter parameter uses the same format of url parameters that is used in a JIRA search.

However, it fails to mention that the first & needs to be omitted.
And does not document what happens if used in conjunction with other forms of filter.

[2] compares the Jira filter with the Maven-style filter.

However, the Jira filter includes more than the Maven filter, as it can also be used to define sorting.

Indeed it appears that the Jira filter overrids all the Maven filters and the sort column names

---

**Affects:** 2.5

2 votes, 3 watchers

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Inizia leggendo la documentazione sui filtri in jira-report-mojo.html#filter e l'esempio di personalizzazione dei report JIRA in examples/customizing-jira-report.html#Using_JIRA_syntax. Aggiorna la documentazione per spiegare l'omissione della e commerciale iniziale, le interazioni con gli altri filtri e l'ordinamento e la precedenza dei filtri JIRA; il lavoro è completato quando entrambe le pagine referenziate descrivono accuratamente il comportamento.

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

Valutazione

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.