Skip to content

Fix JSDoc for device.reboot() - #545

Closed
ttmx wants to merge 1 commit into
DeviceFarmer:masterfrom
ttmx:patch-1
Closed

ttmx wants to merge 1 commit into
DeviceFarmer:masterfrom
ttmx:patch-1

Conversation

@ttmx

@ttmx ttmx commented May 24, 2025

Copy link
Copy Markdown

No description provided.

@koral--

koral-- commented May 25, 2025

Copy link
Copy Markdown
Member

LGTM, but sign-off is missing. You can use e.g. git commit -s ...

koral-- added a commit that referenced this pull request Nov 20, 2026
* docs(jsdoc): fix descriptions copied from other methods

- reboot(): described root(). Describe the reboot and use @returns.
- getFeatures() documented a flags parameter it doesn't take; it belongs
  to getPackages(), whose own @PARAM was a TODO and whose @returns
  described features instead of package names.
- listReverses() said it lists forwarded connections.
- startService() called its options the activity configuration.
- screencap() pointed at the 2.x framebuffer(serial, 'png') signature.

Thanks to @ttmx for spotting the reboot() one in #545.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Karol Wrótniak <karol.wrotniak@droidsonroids.pl>

* docs: fix the same copy-paste mistakes in the README and options

- StartServiceOptions.user said "not set by default", which is true for
  startActivity() only: startService() defaults it to 0, as the README
  says.
- The README had the getFeatures()/getPackages() flags mix-up and the
  listReverses() "forwarded connections" line too, and the 2.x
  framebuffer(serial, 'png') signature under screencap().

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Karol Wrótniak <karol.wrotniak@droidsonroids.pl>

* fix: retry startService() without --user instead of looping

When the device rejected --user, startService() cleared the option to
undefined and called itself, which put --user 0 straight back, so it
retried forever. Clear it to null, which the default leaves alone, and
allow null in StartServiceOptions.user.

Also from review: say that reboot() resolves when adbd closes the
connection, that getPackages() flags go to the device shell unescaped,
name the listReverses() callback value reverses, and point at device.*
for the DeviceClient methods the docs called client.*.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Karol Wrótniak <karol.wrotniak@droidsonroids.pl>

---------

Signed-off-by: Karol Wrótniak <karol.wrotniak@droidsonroids.pl>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
@koral--

koral-- commented Nov 20, 2026

Copy link
Copy Markdown
Member

Superseded with #592

@koral-- koral-- closed this Nov 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants