-
-
Notifications
You must be signed in to change notification settings - Fork 4.1k
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
pymobiledevice3: add page #13215
Conversation
The build for this PR failed with the following error(s):
Please fix the error(s) and push again. |
0c85964
to
3afff5e
Compare
The build for this PR failed with the following error(s):
Please fix the error(s) and push again. |
3afff5e
to
78e07f4
Compare
The build for this PR failed with the following error(s):
Please fix the error(s) and push again. |
There was a problem hiding this comment.
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`
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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`
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
common
,linux
,osx
,windows
,sunos
,android
, etc.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.