Docs site 5/6: javadoc for core public API#51
Draft
zklapow wants to merge 1 commit into
Draft
Conversation
zklapow
force-pushed
the
docs-contributing
branch
from
e618b5a to
1ca318e
Compare
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.
Part 5 of the docs stack (base:
docs-contributing).Adds javadoc to the core public API — previously ~2% coverage; the
-javadocjar that ships to Central with every release was essentially empty, so https://javadoc.io/doc/com.hubspot/boomslang had nothing useful to show. Covered:PythonExecutorFactory(threading model, allrunOnWasmThreadoverloads with honest timeout/poison semantics),PythonInstance(lifecycle, error model, nested exceptions),PythonResult,ResourceLimits(documents thatexecutionTimeoutis not currently enforced, #42),HostBridge,BoomslangExtension,RuntimeImage, and a class-level doc onCopyOnWriteMemory.AsyncHostRegistrywas already documented.mvn -pl core javadoc:javadocpasses with zero warnings. Also adds the API-docs reference page linking javadoc.io and the rustdoc location.Includes a spotless (prettier) formatting pass on the touched files.