You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@commons.apache.org by GitBox <gi...@apache.org> on 2020/08/21 14:44:15 UTC
[GitHub] [commons-collections] TobiasKiecker opened a new pull request #176: changed misleading typo in ListIteratorWrapper.java
TobiasKiecker opened a new pull request #176:
URL: https://github.com/apache/commons-collections/pull/176
While doing research, we found some counterexamples to the original javadoc and thus think that there was a typo.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [commons-collections] kinow commented on pull request #176: changed misleading typo in ListIteratorWrapper.java
Posted by GitBox <gi...@apache.org>.
kinow commented on pull request #176:
URL: https://github.com/apache/commons-collections/pull/176#issuecomment-678749017
Hi @TobiasKiecker
>So I am not sure what would be best here but I think, as it is right now, it is wrong and misleading.
Agree on that. I also noticed the error oddities you mentioned, but since I haven't used much that class, nor maintained that code, I'm not sure what would be the best version.
Feel free to update the PR if you'd like to write a better documentation, I'm sure that'd be helpful to others :+1:
Bruno
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [commons-collections] coveralls edited a comment on pull request #176: changed misleading typo in ListIteratorWrapper.java
Posted by GitBox <gi...@apache.org>.
coveralls edited a comment on pull request #176:
URL: https://github.com/apache/commons-collections/pull/176#issuecomment-678352884
[](https://coveralls.io/builds/32990226)
Coverage remained the same at 90.127% when pulling **d78c7dc49d960b55da9fff848151cb27f5f8095b on TobiasKiecker:fix_javadoc_errors_in_commons.collections4** into **d5de68c2d1cbc68043605ee5286a4f8d08965053 on apache:master**.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [commons-collections] coveralls commented on pull request #176: changed misleading typo in ListIteratorWrapper.java
Posted by GitBox <gi...@apache.org>.
coveralls commented on pull request #176:
URL: https://github.com/apache/commons-collections/pull/176#issuecomment-678352884
[](https://coveralls.io/builds/32916066)
Coverage decreased (-0.03%) to 90.098% when pulling **70fff26e70ac2d6d5457da149f37f1e1cecb777a on TobiasKiecker:fix_javadoc_errors_in_commons.collections4** into **d5de68c2d1cbc68043605ee5286a4f8d08965053 on apache:master**.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [commons-collections] TobiasKiecker commented on pull request #176: changed misleading typo in ListIteratorWrapper.java
Posted by GitBox <gi...@apache.org>.
TobiasKiecker commented on pull request #176:
URL: https://github.com/apache/commons-collections/pull/176#issuecomment-678747096
I just think that there is obviously something wrong with this javadoc.
First, the text states : "Throws UnsupportedOperationException if previous() has ever been called."
while the Throws tag is : "Throws: UnsupportedOperationException - always"
that is already contradicting
Actually it throws IllegalStateException if previous() (or next()) has not been called before.
So it behaves like remove() from the interface "ListIterator" it implements: https://docs.oracle.com/javase/7/docs/api/java/util/ListIterator.html#remove()
The already existing test class: "commons.collections4.iterators.ListIteratorWrapperTest.java"
also proves that the current doc is wrong because it includes a case of calling remove() after previous() has been called, error free.
https://github.com/apache/commons-collections/blob/ac61e06bc174b3571364278feef3a6973d98d0c3/src/test/java/org/apache/commons/collections4/iterators/ListIteratorWrapperTest.java#L159-L168
So I am not sure what would be best here but I think, as it is right now, it is wrong and misleading.
I could write a new commit changing this javadoc completly, if desired.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [commons-collections] kinow closed pull request #176: [COLLECTIONS-765] Update Javadoc of ListIteratorWrapper#remove
Posted by GitBox <gi...@apache.org>.
kinow closed pull request #176:
URL: https://github.com/apache/commons-collections/pull/176
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org