[TEXT-62] Incorporate suggestions from RC2 into 1.0 release

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.0
• Fix Version/s: 1.0
• Assignee: Rob Tompkins
• Reporter: Rob Tompkins
• Created: 27/Jan/17 18:44
• Updated: 17/Mar/17 12:23
• Resolved: 30/Jan/17 12:40

Description

Oliver Heger found some places that we can clean the code up in the release candidate 1.0-beta-1-RC2.

His main points were that mvn site did not work in the src distribution file with the following stack

[ERROR] Failed to execute goal
org.apache.maven.plugins:maven-site-plugin:3.6:site (default-site) on
project commons-text: Error generating
maven-checkstyle-plugin:2.13:checkstyle: Failed during checkstyle
execution: Unable to find suppressions file at location:
C:\data\dev\projects\OpenSource\text\commons-text-1.0-beta-1-src/checkstyle-suppressions.xml:
Could not find resource
'C:\data\dev\projects\OpenSource\text\commons-text-1.0-beta-1-src/checkstyle-suppressions.xml'.

Further some suggestions were that:

1. A user guide be added (maybe look at the one in the history of [lang]'s code)
2. Fix some typographical errors in the RELEASE-NOTES.txt
3. Explain in the RELEASE-NOTE.txt that a considerable amount of the code was ported over from [lang]
4. Fix some of the checkstyle and findbugs errors.

Reference Email.
http://commons.markmail.org/search/?q=#query:%20list%3Aorg.apache.commons.dev+page:1+mid:doqh3t7j5tibeajr+state:results

Issue Links

• links to: GitHub - Commons Text PR#31