NIFI-2816 - Clean typos across the code #1057
Conversation
| @@ -86,9 +86,9 @@ public int read() { | |||
| } | |||
|
|
|||
| /** | |||
| * Returns the byte that would be read without changing the posiiton | |||
| * Returns the byte that would be read without changing the positon | |||
| * | ||
| * @return the byte that would be read without changing the posiiton | ||
| * @return the byte that would be read without changing the positon |
| @@ -164,7 +164,7 @@ public void commit() { | |||
| * {@link org.apache.nifi.processor.Processor#onTrigger} commits or rolls back the | |||
| * session | |||
| */ | |||
| public void clearCommited() { | |||
| public void clearCommitted() { | |||
There was a problem hiding this comment.
Good question. To be honest, I was relying on good old travis to tell.
Seems like it passes but yes, we are renaming a public method.
| @@ -47,7 +47,7 @@ public void setMaxTimerDrivenThreadCount(Integer maxTimerDrivenThreadCount) { | |||
| * @return maximum number of event driven thread this NiFi has available | |||
| */ | |||
| @ApiModelProperty( | |||
| value = "The maximum number of event driven threads the NiFi has avaiable." | |||
| value = "The maximum number of event driven threads the NiFi has avaliable." | |||
| @@ -25,7 +25,7 @@ | |||
| * This password hashing system tries to thwart off-line password | |||
| * cracking using a computationally-intensive hashing algorithm, | |||
| * based on Bruce Schneier's Blowfish cipher. The work factor of | |||
| * the algorithm is parameterised, so it can be increased as | |||
| * the algorithm is parametrised, so it can be increased as | |||
|
@pvillard31 note to myself: Never try to hunt typos after midnight ... 😃 |
|
@pvillard31 I did a second sweep on this commit and the following public classes or methods have also been changed org.apache.nifi.cluster.coordination.http.endpoints.ConnectionStatusEndpointMerger What would be your suggesting? Rename the classes and public methods or leave them untouched? One idea I had - not sure if it is adequate - is to re-introduce the removed methods/classes but add a deprecation annotation (part of the second commit to this PR) |
trixpan
force-pushed
the
typos
branch
2 times, most recently
from
9f2bc41
to
2824f4f
Compare
|
@trixpan, to be honest, about classes/methods renaming I'll concede to our PMC authority. |
|
@trixpan @pvillard31 since the three changes in question are not part of the public API we should be ok to change them as long as it is done on a second number version change (1.1.0 and not 1.0.1) which is what we are planning anyway, this should be consistent with our versioning/compatibility guide https://cwiki.apache.org/confluence/display/NIFI/Version+Scheme+and+API+Compatibility |
|
@pvillard31 I agree, lets remove the deprecated versions and just have the corrected versions, I'm a +1 after that change, and thanks to @trixpan for putting this together, didn't realize how many typos we had! |
|
yeah i def don't think we need deprecation notes for those. Should just be able to fix the typos. |
|
also @trixpan and reviewers: Thanks for doing this plus stale branch hunting. It is greatly appreciated. |
|
Merging... |
This closes apache#1057.
part 1 of typo hunting