[jira] [Commented] (LANG-1059) Capitalize javadoc is incorrect

["Bruno P. Kinoshita (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/LANG-1059?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14501616#comment-14501616 ] 

Bruno P. Kinoshita commented on LANG-1059:
------------------------------------------

I think changing from "letter" to "character" would be fine, but we would have to change the capitalize/uncapitalize methods, and also update the javadocs of the similar methods in WordUtils (which use the letter too).

While it can be misleading for some users, at least the javadocs mention the method called in the Character class - which contains more extensive documentation on how the characters are un/capitalized. 

> Capitalize javadoc is incorrect
> -------------------------------
>
>                 Key: LANG-1059
>                 URL: https://issues.apache.org/jira/browse/LANG-1059
>             Project: Commons Lang
>          Issue Type: Improvement
>          Components: lang.*
>    Affects Versions: 3.3.2
>            Reporter: Colin Casey
>            Priority: Minor
>
> The below also applies to uncapitalize.
> Currently the javadocs say:
> bq. Capitalizes a String changing the first letter to title case as per Character.toTitleCase(char). No other letters are changed.
> A more accurate description would be: 
> bq. Capitalizes a String changing the first *character* to title case as per Character.toTitleCase(char). No other letters are changed.
> capitalize("'word'") is an example where the current docs are false (note single-quote is first character but not first letter and nothing gets capitalized)
> This may in fact be a bug if the current docs are correct.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)