You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wicket.apache.org by "Martin Grigorov (JIRA)" <ji...@apache.org> on 2015/09/07 00:42:45 UTC

[jira] [Resolved] (WICKET-5976) Improve the documentation of FeedbackMessages first(int level)

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

Martin Grigorov resolved WICKET-5976.
-------------------------------------
       Resolution: Fixed
         Assignee: Martin Grigorov
    Fix Version/s: 7.1.0
                   6.21.0

I've updated the javadoc to be more close to the behavior.
As I explained we cannot do API or behavior changes in minor versions.
Thanks!

> Improve the documentation of FeedbackMessages first(int level)
> --------------------------------------------------------------
>
>                 Key: WICKET-5976
>                 URL: https://issues.apache.org/jira/browse/WICKET-5976
>             Project: Wicket
>          Issue Type: Improvement
>          Components: wicket
>    Affects Versions: 7.0.0
>            Reporter: Robert Bain
>            Assignee: Martin Grigorov
>            Priority: Minor
>             Fix For: 6.21.0, 7.1.0
>
>   Original Estimate: 3h
>  Remaining Estimate: 3h
>
> FeedbackMessages method public final FeedbackMessage first(int level) has documentation specifying that it "Retrieves the first message matching the specified level" when in fact it calls FeedbackMessage's isLevel(int level) which "Returns whether this level is greater than or equal to the given level." which is also poorly named as it doesn't return whether the FeedbackMessage is of the specified level; it returns if it's of the specified level or more severe.
> In my opinion both the current functionality and the functionality to return only those messages of a specified level are desirable. A minimal solution is an update to the documentation of FeedbackMessage's first(int level) method but I think the methods should be renamed to say what they actually do.



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