The public API documentation is sparse and inconsistent. Running asdf exec bundle exec yard stats --list-undoc reports only 50.00 percent documented, with 21 of 22 modules, 90 of 106 classes, 71 of 102 constants, and 137 of 285 methods undocumented. The missing public surface includes central entry points such as Arcp::Client.open, Arcp::Client#submit_job, Arcp::Runtime::Runtime, Arcp::Runtime::JobContext, the transport classes, the lease and credential value objects, event body classes, and most error classes.
Fix prompt: Choose YARD or RDoc as the single convention for this SDK and document the public classes, modules, constants, and methods that users call directly. Each public method should include parameters, return values, raised ARCP exceptions, mutability or thread/fiber expectations where relevant, and a compact Ruby example when the behavior is not obvious from the name. Mark internal helpers with @api private or make them private so generated docs do not imply support, and add a CI check that runs yard stats --fail-on-warning or an equivalent documentation threshold.
The public API documentation is sparse and inconsistent. Running
asdf exec bundle exec yard stats --list-undocreports only 50.00 percent documented, with 21 of 22 modules, 90 of 106 classes, 71 of 102 constants, and 137 of 285 methods undocumented. The missing public surface includes central entry points such asArcp::Client.open,Arcp::Client#submit_job,Arcp::Runtime::Runtime,Arcp::Runtime::JobContext, the transport classes, the lease and credential value objects, event body classes, and most error classes.Fix prompt: Choose YARD or RDoc as the single convention for this SDK and document the public classes, modules, constants, and methods that users call directly. Each public method should include parameters, return values, raised ARCP exceptions, mutability or thread/fiber expectations where relevant, and a compact Ruby example when the behavior is not obvious from the name. Mark internal helpers with
@api privateor make them private so generated docs do not imply support, and add a CI check that runsyard stats --fail-on-warningor an equivalent documentation threshold.