apache / apache/maven-changes-plugin
[MCHANGES-257] Improve filter documentation
- Dominant language
- Java
- Stars
- 15
- Forks
- 22
- Avg merge
- 8h 1m
- Merged PRs (30d)
- 3
Description
**[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
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reading the filter documentation at jira-report-mojo.html#filter and the customizing JIRA report example at examples/customizing-jira-report.html#Using_JIRA_syntax. Update the documentation to explain the omitted leading ampersand, interactions with other filters, and JIRA filter sorting and precedence; done means both referenced pages accurately describe the behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100