[MCHANGES-257] Improve filter documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- java
- Domain
- documentation
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.
Description
Sebb opened MCHANGES-257 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
- Dominant language
- Java
- Stars
- 15
- Forks
- 22
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 7
Contributor guide
No contributing guide indexed for this repository
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.
More from apache/maven-changes-plugin
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 55/100
apache/maven-changes-plugin#650 ·
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 52/100
apache/maven-changes-plugin#633 ·
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 48/100
apache/maven-changes-plugin#619 ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 25/100
apache/maven-changes-plugin#610 ·
-
bug
Difficulty 4/5 3-5 days Newbie friendliness 30/100
apache/maven-changes-plugin#608 ·
All issues in apache/maven-changes-plugin
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
opensearch-project/k-NN#3597 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100