[jira] [Commented] (TEXT-234) Inconsistent documentation for setNewLineText and appendNewLine
[
https://issues.apache.org/jira/browse/TEXT-234?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17848117#comment-17848117
]
TobiasKiecker commented on TEXT-234:
We also found the same issue in _commons-lang_ and its StrBuilder Class. I will
also open a PR for that.
> Inconsistent documentation for setNewLineText and appendNewLine
>
>
> Key: TEXT-234
> URL: https://issues.apache.org/jira/browse/TEXT-234
> Project: Commons Text
> Issue Type: Improvement
>Affects Versions: 1.12.0
>Reporter: TobiasKiecker
>Priority: Minor
> Labels: documentation
>
> The method _setNewLineText_ in both _StrBuilder_ and _TextStringBuilder_ have
> ambiguous documentation. If someone were to extend the class and override
> _appendNewLine_ null would not be handled anymore.
> The docstring of s{_}etNewlineText{_} implies that THIS function does the
> handling, while in truth it is done in _appendNewLine._
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
[jira] [Commented] (TEXT-234) Inconsistent documentation for setNewLineText and appendNewLine
[
https://issues.apache.org/jira/browse/TEXT-234?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17847469#comment-17847469
]
Gary D. Gregory commented on TEXT-234:
--
[~tobiaskiecker]
Thank you for your report.
Feel free to create a PR on GitHub and document the existing behavior better.
> Inconsistent documentation for setNewLineText and appendNewLine
>
>
> Key: TEXT-234
> URL: https://issues.apache.org/jira/browse/TEXT-234
> Project: Commons Text
> Issue Type: Improvement
>Affects Versions: 1.12.0
>Reporter: TobiasKiecker
>Priority: Minor
> Labels: documentation
>
> The method _setNewLineText_ in both _StrBuilder_ and _TextStringBuilder_ have
> ambiguous documentation. If someone were to extend the class and override
> _appendNewLine_ null would not be handled anymore.
> The docstring of s{_}etNewlineText{_} implies that THIS function does the
> handling, while in truth it is done in _appendNewLine._
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
