search

OCA-Creations / Ally

A powerful command-line tool for managing ZSH aliases, written in Swift.
MIT License
2 stars 0 forks source link

[FEATURE REQUEST] Impliment `man` #2

Open MrDevel0per opened 1 year ago

MrDevel0per commented 1 year ago

Is your feature request related to a problem? Please describe. Yes - somewhat. When running man ally, we get the error:

No manual entry for ally

It's worth noting that this may come from ally not being in PATH, but instead being an alias. An issue for this discussion will be created soon.

Describe the solution you'd like According to https://forums.swift.org/t/when-to-use-swiftpm-plugin-for-generating-man-pages/59010, we should be able to generate a man page - maybe in a Build Step? Then, when running man ally, we should see the following output:

... Autogenerated manpage here (see `man ls` for an idea).

Describe alternatives you've considered ally help and ally help SUBCOMMAND, as well as the normal help variations, already provide useful info. We do need to improve the command docs (again, this will be in a soon-to-create issue), but this functionality is already somewhat available, just not with man.

MrDevel0per commented 1 year ago

This is available with ArgumentParser: apple/swift-argument-parser#332. Should we impliment it?

MrDevel0per commented 1 year ago

Worth noting here that

Man pages have a long and strong tradition as being the primary source of documentation for a command line program, a protocol, a library function, etc.

In contrast to the usually brief help with regards to the syntax of a tool, they‘re supposed to cover much more information.

... But that might not be the case anymore. this is from the link above.

MrDevel0per commented 10 months ago

Completed and in testing. Will link commit soon.