Update documentation #788
Update documentation #788
Conversation
…rowse/LOG4J2-3429 Also, corrected typo in builder method name 'withtFilter' -> 'withFilter'
| @@ -214,7 +214,7 @@ public Filter getFilter() { | |||
| return filter; | |||
| } | |||
|
|
|||
| public B withtFilter(Filter filter) { | |||
| public B withFilter(Filter filter) { | |||
There was a problem hiding this comment.
I have mixed feelings about this change: yes, it would be nice to have a correctly spelled method, but the other one was already released and it is API.
Don't change the name of the method, deprecate it and add another one with the correct spelling.
There was a problem hiding this comment.
I deprecated the misspelled method and created a new one with the correct spelling as suggested.
There was a problem hiding this comment.
There were two such cases.
What is the rule for naming methods?
When should the name be setFilter and when withFilter?
I just noticed that the appender was changed from withFilter to setFilter.
Should the same be done here?
There was a problem hiding this comment.
I have mixed feelings about this change: yes, it would be nice to have a correctly spelled method, but the other one was already released and it is API.
Don't change the name of the method, deprecate it and add another one with the correct spelling.
Just add a new method with the correct name and deprecate the bogus one. Simple ;-)
|
The "with" style is old, the "set" style is new. We already deprecated a bunch of "with" methods in favor of "set" methods. |
|
This was closed automatically by Github because we renamed the |
Documentation corrections an updates as mentioned in https://issues.apache.org/jira/b…rowse/LOG4J2-3429
Corrected typo in builder method 'withtFilter' -> 'withFilter'