You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@commons.apache.org by "Gary D. Gregory (Jira)" <ji...@apache.org> on 2024/05/21 19:53:00 UTC

[jira] [Updated] (TEXT-234) Improve StrBuilder documentation for new line text

     [ https://issues.apache.org/jira/browse/TEXT-234?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Gary D. Gregory updated TEXT-234:
---------------------------------
    Summary: Improve StrBuilder documentation for new line text  (was: Improve documentation for setNewLineText and appendNewLine)

> Improve StrBuilder documentation for new line text
> --------------------------------------------------
>
>                 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)