Formed in 2009, the Archive Team (not to be confused with the archive.org Archive-It Team) is a rogue archivist collective dedicated to saving copies of rapidly dying or deleted websites for the sake of history and digital heritage. The group is 100% composed of volunteers and interested parties, and has expanded into a large amount of related projects for saving online and digital history.
Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign updocs: synchronize help text #742
Conversation
| asdf plugin remove <name> Remove plugin and package versions | ||
| asdf plugin update <name> [<git-ref>] Update a plugin to latest commit or a particular git-ref. | ||
| asdf plugin update --all Update all plugins | ||
| asdf plugin add <name> [<git-url>] Add a plugin from the plugin repo OR, add a Git repo as a plugin by specifying the name and repo url |
Stratus3D
Jun 15, 2020
Member
I think we should still wrap this text at 80 columns. I work on pretty small screens and my terminal is usually around 80 columns.
I think we should still wrap this text at 80 columns. I work on pretty small screens and my terminal is usually around 80 columns.
| asdf install [<name> <version>] Install a specific version of a package or, with no arguments, install all the package versions listed in the .tool-versions file | ||
| asdf install <name> latest[:<version>] Install the latest stable version of a package, or with optional version, install the latest stable version that begins with the given string | ||
| asdf uninstall <name> <version> Remove a specific version of a package | ||
| asdf current Display current version set or being used for all packages |
Stratus3D
Jun 15, 2020
Member
This is what I see with wrapping text. I find it hard to follow when it wraps all the way around. 
This is what I see with wrapping text. I find it hard to follow when it wraps all the way around. 
|
I would prefer we continue to wrap text around 80 columns but all the changes to the help text itself look good to me! |
|
My goal here was to remove the inline formatting and rely on the print mechanism to perform formatting. Currently help is output with |
|
Here's a diff from the last two commits showing strict vs relaxed 80 char wrapping. Relaxed doesn't wrap individual words. |
|
I'd like to get this in and will follow up in another PR with formatting being moved into the printing function and not the content. |
Summary
The help text and "All Commands" doc site page have been getting updates differently. They've fallen out of sync. While crude, I would like to solve the discrepancy by directly importing the
help.txtfile into the docs.I don't imagine that page to be heavily visited, it was only included for completeness of the documentation site. This is a better in-between.
Other Information
I removed the 2 space indentation of the
help.txtfor all commands. This allows for more content to be horizontally filled.I removed the inline word wrapping. I will follow this PR up with a change to render the help text via
awkonasdf/asdf helpand perform wrapping.