#12 correct Javadoc on TkApp.app() static factory - #388
Open
edmoffo wants to merge 1 commit into
Open
Conversation
The private static `app(Base)` method is a factory that builds the Take pipeline; the previous `Ctor.` Javadoc incorrectly described it as a constructor.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue #12 calls out a few private static members in this codebase that read awkwardly. The clearest defect of that set is in
src/main/java/net/rehttp/tk/TkApp.javaat line 60: the private static factoryapp(Base)carries aCtor.Javadoc summary, but it is not a constructor — it builds and returns theTakepipeline thatTkApp's real constructor passes up tosuper(...). This change rewrites that single Javadoc sentence to describe what the method actually does.No production code is touched, no signatures change, no behavior changes. The only diff is one Javadoc line in
TkApp.java. Generated documentation now matches the source.Verified locally with
mvn clean install -Pquliceon JDK 17. The build reports the same pre-existing 28 HeaderCheck violations that are present onmaster(the SPDX header is not yet aligned with the checkstyle template); this patch neither adds nor removes any of them. The latestmvnworkflow runs onmasterare red for the same reason, unrelated to this change.Closes #12