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

pymobiledevice3: add page #13215

Closed
wants to merge 1 commit into from

Conversation

doronz88
Copy link

@doronz88 doronz88 commented Jul 2, 2024

  • 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 PR title conforms to the recommended templates.
  • Version of the command being documented (if known): v4.10.2

I included more then 8 examples since this CLI utility is a swiss-army-knife for doing many common operations with a connected iPhone (backup, reboot, device logs and etc) so put only the commands I heard for the community this is the most common ones to be used. I hope this is okay.

@doronz88 doronz88 requested a review from spageektti as a code owner July 2, 2024 16:05
@github-actions github-actions bot added the new command Issues requesting creation of a new page. label Jul 2, 2024
@CLAassistant
Copy link

CLAassistant commented Jul 2, 2024

CLA assistant check
All committers have signed the CLA.

@tldr-bot
Copy link

tldr-bot commented Jul 2, 2024

The build for this PR failed with the following error(s):

pages/common/pymobiledevice3.md:3: TLDR004 Command descriptions should end in a period
pages/common/pymobiledevice3.md:6: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:6: TLDR104 Example descriptions should prefer infinitive tense (e.g. write) over present (e.g. writes) or gerund (e.g. writing)
pages/common/pymobiledevice3.md:10: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:14: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:18: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:22: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:26: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:30: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:34: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:38: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:42: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:46: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:50: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:58: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:62: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:66: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:70: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:74: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:78: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:82: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:86: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:94: TLDR104 Example descriptions should prefer infinitive tense (e.g. write) over present (e.g. writes) or gerund (e.g. writing)
pages/common/pymobiledevice3.md:98: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:102: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:106: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:110: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/pymobiledevice3.md:0: TLDR019 Page should only include a maximum of 8 examples

Please fix the error(s) and push again.

@tldr-bot
Copy link

tldr-bot commented Jul 2, 2024

The build for this PR failed with the following error(s):

pages/common/pymobiledevice3.md:0: TLDR019 Page should only include a maximum of 8 examples

Please fix the error(s) and push again.

@tldr-bot
Copy link

tldr-bot commented Jul 2, 2024

The build for this PR failed with the following error(s):

pages/common/pymobiledevice3.md:0: TLDR019 Page should only include a maximum of 8 examples

Please fix the error(s) and push again.

Copy link
Member

@sebastiaanspeck sebastiaanspeck Jul 3, 2024

Choose a reason for hiding this comment

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

I think it is better if we split this page in subcommand-pages, so this page could list some of the subcommands like:

# pymobiledevice3

> Interact with a connected iDevice (iPhone, iPad, ...).
> Some subcommands such as `pymobiledevice3 syslog` have their own usage documentation.
> More information: <https://github:com/doronz88/pymobiledevice3>.

- View documentation for syslog:

`tldr pymobiledevice3 syslog`

- View documentation for usbmux:

`tldr pymobiledevice3 usbmux`

Copy link
Author

Choose a reason for hiding this comment

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

The problem with that is that on many occasions people don't know the subcommand that are looking for by the subcommand. For example, most people don't know at first that usbmux is used for TCP forwarding and discovering the connected device list though it is clear for those that read the full documentation

Copy link
Member

Choose a reason for hiding this comment

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

The problem with that is that on many occasions people don't know the subcommand that are looking for by the subcommand. For example, most people don't know at first that usbmux is used for TCP forwarding and discovering the connected device list though it is clear for those that read the full documentation

Therefore you should provide a clear description:

# pymobiledevice3

> Interact with a connected iDevice (iPhone, iPad, ...).
> Some subcommands such as `pymobiledevice3 syslog` have their own usage documentation.
> More information: <https://github:com/doronz88/pymobiledevice3>.

- View documentation for syslog:

`tldr pymobiledevice3 syslog`

- View documentation for TCP forwarding and discovering the connected device list:

`tldr pymobiledevice3 usbmux`

Copy link
Author

@doronz88 doronz88 Jul 4, 2024

Choose a reason for hiding this comment

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

I see. However, this would completely defeat the purpose of tldr in that case since it will be the equivalent of just hitting each subcommand and view its usage.

Copy link
Author

Choose a reason for hiding this comment

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

Is there instead maybe a way to just tldr to look at additional PATH for other commands?

@acuteenvy acuteenvy changed the title common: add pymobiledevice3 pymobiledevice3: add page Jul 3, 2024
@doronz88 doronz88 closed this Jul 4, 2024
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants