diff options
| author | knu <knu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2001-07-05 15:47:03 +0000 |
|---|---|---|
| committer | knu <knu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2001-07-05 15:47:03 +0000 |
| commit | eab46f5fc61b08cdcef60954dc6e71b4bee0a201 (patch) | |
| tree | a716a25772aa251b51769d9c21ad8a98eef2f0fe /ext/readline/README | |
| parent | afb3a0cff187cee400c4249f22422a56ad6156f4 (diff) | |
| download | ruby-eab46f5fc61b08cdcef60954dc6e71b4bee0a201.tar.gz | |
Detypo and reword a bit.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@1568 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'ext/readline/README')
| -rw-r--r-- | ext/readline/README | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/ext/readline/README b/ext/readline/README index 1eb1f8bb64..9bbf325c99 100644 --- a/ext/readline/README +++ b/ext/readline/README @@ -11,17 +11,18 @@ Example: <module function> -readline(prompt, add_hostory=nil) +readline(prompt, add_history=nil) - Reads one line wit line edit. the line is added to the - history also if "add" is true. + Reads one line with line editing. The inputted line is added to the + history if add_history is true. -<class mehods> +<class methods> completion_proc = proc - Specifies Proc object to determin completion behavior. It - shoule take input-string, and return completion candidates. + Specifies a Proc object to determine completion behavior. It + should take input-string, and return an array of completion + candidates. completion_proc @@ -37,12 +38,13 @@ completion_case_fold completion_append_character = char - Specifies a chacatcter to be appended on completion. - Nothing will be appended if empty string ("") or nil is specified. + Specifies a character to be appended on completion. + Nothing will be appended if an empty string ("") or nil is + specified. completion_append_character - Returns a string contains a character to be appended on + Returns a string containing a character to be appended on completion. The default is a space (" "). vi_editing_mode |