1
0
mirror of https://github.com/pyenv/pyenv.git synced 2025-11-16 15:23:53 -05:00

new-style documentation for most commands

This commit is contained in:
Mislav Marohnić
2012-12-29 23:34:53 +01:00
parent 5cc6b0e3d3
commit 3436bddaea
18 changed files with 73 additions and 8 deletions

View File

@@ -1,4 +1,16 @@
#!/usr/bin/env bash
#
# Summary: Display help for a command
#
# Usage: rbenv help [--usage] COMMAND
#
# Parses and displays help contents from a command's source file.
#
# A command is considered documented if it starts with a comment block that has
# at least one of the following sections: `Summary' and `Usage'. Usage
# instructions can span multiple lines as long as subsequent lines are indented.
# Everything else in the comment is considered to be regular help contents.
set -e
[ -n "$RBENV_DEBUG" ] && set -x