Improve StreamMapToOptionalGet Refaster template documentation
#203
Conversation
Stephan202
force-pushed
the
rossendrijver/javadoc_improvement
branch
from
451643c to
493db87
Compare
|
Suggested commit message: |
| * Within a stream's map operation unconditional {@link Optional#orElseThrow()} calls can be | ||
| * avoided. | ||
| * | ||
| * <p><strong>Warning:</strong> this rewrite rule is not completely behavior preserving. The |
There was a problem hiding this comment.
In most cases since we're in a stream already I suppose flattening the Optional would be the user's intention, but I wonder how we could also convey/educate users with the changes that are made for them. Now, the process is such that if they don't like a change, they will ping @rickie to ask, but it might be nice to also think of an automated solution for templates similar to how there's documentation for bug patterns.
There was a problem hiding this comment.
Yeah, have been pondering the same. Ideally the Refaster check can emit custom error messages, just like other BugCheckers. We might be able to use annotations for this; TBD.
Next to that we should generate Github pages (or equivalent) and link to that.
There was a problem hiding this comment.
Also bounced a few ideas offline just now with @rickie. Annotations would be super nice -- we could also use it to indicate whether some things are behavior preserving or not, and I'm sure we can think of many more nice categories. :)
There was a problem hiding this comment.
There are a lot of cool ideas and options. Would be really nice to get stuff like that done 😍.
rickie
changed the title
StreamMapToOptionalGet JavadocStreamMapToOptionalGet Refaster template documentation
No description provided.