NONE: Add Browser's KDocs #60
Conversation
|
|
||
| /** | ||
| * Installs browser and WebDriver. See [Chrome] or [com.atlassian.performance.tools.infrastructure.api.browser.chromium.Chromium69]. | ||
| * Browser must provide public no-args constructor. |
There was a problem hiding this comment.
They don't have to provide public constructor.
We only require this no-arg stuff, where we're forced to use reflection, that is in a cross-JVM communication between the local JVM and the remote VU JVMs. So only the VU SPIs require the nullary constructor.
| [Unreleased]: https://github.com/atlassian/infrastructure/compare/release-4.14.5...master | ||
|
|
||
| ### Added | ||
| - `com.atlassian.performance.tools.infrastructure.api.browser.Browser` KDocs. |
There was a problem hiding this comment.
Technically it adds behavioral contracts:
Browserhas to install WebDriver (we don't need this contract IMHO)SshConnectiontargets Ubuntu - this one is critical for implementors, so we need it
There was a problem hiding this comment.
@dagguh Are you suggesting this should be explicitly stated in the changelog?
There was a problem hiding this comment.
Yeah, that's the diff.
I wanna empathize with lib consumers. As a consumer of a lib, I'm gonna look for useful stuff, e.g. "since when can I rely on it being Ubuntu?". Not gonna look for "when did KDocs appear"?
Docs themselves are a standalone description and changelog is a series of human-level diffs.
3 participants
No description provided.