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

[FEATURE REQUEST] Impliment man #2

Open
MrDevel0per opened this issue Sep 25, 2023 · 3 comments
Open

[FEATURE REQUEST] Impliment man #2

MrDevel0per opened this issue Sep 25, 2023 · 3 comments
Labels
argument-parser Deals with Swift's ArgumentParser library enhancement New feature or request

Comments

@MrDevel0per
Copy link
Contributor

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 MrDevel0per added the enhancement New feature or request label Sep 25, 2023
@MrDevel0per
Copy link
Contributor Author

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

@MrDevel0per
Copy link
Contributor Author

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 MrDevel0per added the argument-parser Deals with Swift's ArgumentParser library label Nov 24, 2023
@MrDevel0per
Copy link
Contributor Author

Completed and in testing. Will link commit soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
argument-parser Deals with Swift's ArgumentParser library enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant