Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Confusing docs about unchecked exceptions decorators #871

Closed
neonailol opened this issue May 14, 2018 · 5 comments
Closed

Confusing docs about unchecked exceptions decorators #871

neonailol opened this issue May 14, 2018 · 5 comments

Comments

@neonailol
Copy link
Contributor

In the documentation of some classes, there this copied and pasted paragraph

 * <p>This class implements {@link Scalar}, which throws a checked
 * {@link Exception}. This may not be convenient in many cases. To make
 * it more convenient and get rid of the checked exception you can
 * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>

Which tells that to get rid of checked exception I can use IoCheckedScalar class,
but IoCheckedScalar throws a checked IOException, so maybe this text should be rephrased

Some examples:

* <p>This class implements {@link Scalar}, which throws a checked
* {@link Exception}. This may not be convenient in many cases. To make
* it more convenient and get rid of the checked exception you can
* use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>

* <p>This class implements {@link Scalar}, which throws a checked
* {@link Exception}. This may not be convenient in many cases. To make
* it more convenient and get rid of the checked exception you can
* use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>

* <p>This class implements {@link Scalar}, which throws a checked
* {@link Exception}. This may not be convenient in many cases. To make
* it more convenient and get rid of the checked exception you can
* use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>

@0crat
Copy link
Collaborator

0crat commented May 14, 2018

@llorllale/z please, pay attention to this issue

@0crat
Copy link
Collaborator

0crat commented May 14, 2018

@neonailol/z this project will fix the problem faster if you donate a few dollars to it; just click here and pay via Stripe, it's very fast, convenient and appreciated; thanks a lot!

llorllale added a commit that referenced this issue May 22, 2018
@llorllale
Copy link
Contributor

@neonailol see 8684193. Better now?

@neonailol
Copy link
Contributor Author

@llorllale yes, looks good now

@0crat
Copy link
Collaborator

0crat commented May 22, 2018

The job is not in WBS, won't close the order

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants