Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adb-connect, adb-pair, adb-disconnect: add page #15250

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

Managor
Copy link
Collaborator

@Managor Managor commented Dec 20, 2024

#13997

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page(s) have at most 8 examples.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The page(s) follow the style guide.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known):

@github-actions github-actions bot added the new command Issues requesting creation of a new page or PRs adding a new page for a command. label Dec 20, 2024
@Managor
Copy link
Collaborator Author

Managor commented Dec 20, 2024

adb is a painful how it has tons of subcommands that do a singular thing.

@Managor Managor mentioned this pull request Dec 20, 2024
83 tasks
@gutjuri
Copy link
Member

gutjuri commented Dec 20, 2024

I think that the example with adb disconnect belongs in the adb disconnect page

@Managor
Copy link
Collaborator Author

Managor commented Dec 20, 2024

I disagree. Scattered subcommands that relate to each other and do a singular thing should be grouped together for easy access. There is no variation for how adb disconnect is used so having it be on its own page would be useless.

@gutjuri
Copy link
Member

gutjuri commented Dec 21, 2024

But adb connect is clearly not an alias for adb disconnect, which the page for adb disconnect currently suggests.

@Managor
Copy link
Collaborator Author

Managor commented Dec 21, 2024

That's true. I've been thinking if we could use a some other format for when a command has been moved.

Comment on lines 3 to 5
> This command is an alias of `adb connect`.

- View documentation for the original command:
Copy link
Collaborator Author

@Managor Managor Dec 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> This command is an alias of `adb connect`.
- View documentation for the original command:
> This command has been moved to `adb connect`.
- View documentation for `adb disconnect`:

Something like this?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would be okay in my opinion. However, I'd like to wait for other reviewers' opinions on this one.

Copy link
Member

@sebastiaanspeck sebastiaanspeck Dec 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe "has been moved to adb connect"?

And the second line is a bit strange; "view adb disconnect --> tldr adb connect

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you make a suggestion for what you mean with the second line?

pages/common/adb-pair.md Outdated Show resolved Hide resolved
Copy link
Member

@spageektti spageektti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi. Thanks for your contribution. I wish a wonderful christmas time!

pages/common/adb-connect.md Outdated Show resolved Hide resolved
pages/common/adb-connect.md Outdated Show resolved Hide resolved
pages/common/adb-pair.md Outdated Show resolved Hide resolved
Managor and others added 2 commits December 31, 2024 06:53
Co-authored-by: Sebastiaan Speck <[email protected]>
Co-authored-by: Sebastiaan Speck <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page or PRs adding a new page for a command.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants