Claude fix all docstring problems & add check to CI#2822
Claude fix all docstring problems & add check to CI#2822Sushisource wants to merge 2 commits intotemporalio:masterfrom
Conversation
Sushisource
force-pushed
the
fix-jdocs
branch
2 times, most recently
from
6c8eadd to
3929a2d
Compare
| uses: gradle/actions/setup-gradle@v5 | ||
|
|
||
| - name: Run javadoc | ||
| run: ./gradlew --no-daemon javadoc |
There was a problem hiding this comment.
Is this added only as a pass-or-fail check, or are you suggesting we do something with the output of that?
There was a problem hiding this comment.
It's pass fail - but you can see the output and fix any issues locally?
| * @see #getResult(Class) as a sync version of this method for detailed information about | ||
| * exceptions that may be thrown from {@link CompletableFuture#get()} wrapped by {@link | ||
| * ExecutionException} | ||
| * exceptions that may be thrown from CompletableFuture.get() wrapped by ExecutionException |
There was a problem hiding this comment.
Not sure why Claude removed the links on those two, I think they should stay.
There was a problem hiding this comment.
It's because Jdoc doesn't allow you to have links inside of a see block... which is stupid. Unfortunately it applies to all of these and there's not a great option beyond like... moving them all out into just plain paragraphs or something. Not sure if that's worth it.
There was a problem hiding this comment.
Ah, right, that's actually a misuse of the @see tag (see spec).
The correct thing to do would be to move those to a normal description paragraph, before the first @param or @return tag.
temporal-sdk/src/main/java/io/temporal/client/WorkflowStub.java
Outdated
Show resolved
Hide resolved
temporal-sdk/src/main/java/io/temporal/client/WorkflowStub.java
Outdated
Show resolved
Hide resolved
temporal-sdk/src/main/java/io/temporal/client/WorkflowStub.java
Outdated
Show resolved
Hide resolved
temporal-sdk/src/main/java/io/temporal/common/interceptors/WorkflowInboundCallsInterceptor.java
Outdated
Show resolved
Hide resolved
2 participants
All these Javadoc issues were driving me nuts. Cleaned them up with Claude and added CI step to verify we don't regress.