Wrap documentation comments at 70 columns

This commit is contained in:
Sam Stephenson 2012-12-29 21:50:38 -06:00
parent 3436bddaea
commit 19666f2598
5 changed files with 15 additions and 13 deletions

View file

@ -1,12 +1,13 @@
#!/usr/bin/env bash
# Summary: Display the version of rbenv
#
# Displays the current revision info of rbenv from git if available, or falls
# back to the version of the last release.
# Displays the current revision info of rbenv from git if available,
# or falls back to the version of the last release.
#
# The format of the git revision is:
# ${version}-${num_commits}-g${git_sha}
# where `num_commits` is the number of commits since `version` was tagged.
# where `num_commits` is the number of commits since `version` was
# tagged.
set -e
[ -n "$RBENV_DEBUG" ] && set -x

View file

@ -4,8 +4,8 @@
#
# Usage: rbenv exec COMMAND [arg1 arg2...]
#
# Runs an executable by first preparing PATH so that the selected Ruby version
# is prepended to it.
# Runs an executable by first preparing PATH so that the selected Ruby
# version is prepended to it.
#
# For example, doing:
# RBENV_VERSION=1.9.3-p327 rbenv exec bundle install

View file

@ -6,10 +6,11 @@
#
# 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.
# 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

View file

@ -2,8 +2,8 @@
# Summary: Display prefix for a Ruby version
# Usage: rbenv prefix [<version>]
#
# Displays the directory where a Ruby version is installed. If no version is
# given, it uses the currently selected version.
# Displays the directory where a Ruby version is installed. If no
# version is given, it uses the currently selected version.
set -e
[ -n "$RBENV_DEBUG" ] && set -x

View file

@ -1,8 +1,8 @@
#!/usr/bin/env bash
# Summary: Show the current Ruby version and its origin
#
# Shows the current Ruby version and where it's set from. To obtain only the
# version string, use `rbenv version-name'.
# Shows the current Ruby version and where it's set from. To obtain
# only the version string, use `rbenv version-name'.
set -e
[ -n "$RBENV_DEBUG" ] && set -x