[sup] ask_* functions from buffer.rb

[Ruthard Baudach]

The ask* functions in buffer.rb are not commented. As far as I found
out, the arguments are:

domain: token used as key for @textfields, which seems to be a
dictionary of input field objects
question: string used as prompt
completions: array of possible answers, that can be completed by using
the tab key
default: default value to return

Is this correct?

Greetings,
Ruthard

[Gaute Hope]

Post by Ruthard Baudach
The ask* functions in buffer.rb are not commented. As far as I found
dictionary of input field objects
question: string used as prompt
completions: array of possible answers, that can be completed by using
the tab key
default: default value to return
Is this correct?

Most likely.

Correct me if I am wrong, but I don't think any of the active sup devs
were involved in writing those functions :) I would happily accept a
patch with some comments.

Cheers, Gaute

[Ruthard Baudach]

Dear Gaute,

Warning! I never made patches before, so have a close look on this one
before messing anything up.

Attached is my first attempt at creating a patch for
sup/lib/sup/buffer.rb adding a comment for the dialog functions

Post by Gaute Hope

Post by Ruthard Baudach
The ask* functions in buffer.rb are not commented. As far as I found
dictionary of input field objects
question: string used as prompt
completions: array of possible answers, that can be completed by using
the tab key
default: default value to return
Is this correct?

Most likely.
Correct me if I am wrong, but I don't think any of the active sup devs
were involved in writing those functions :) I would happily accept a
patch with some comments.
Cheers, Gaute

[Gaute Hope]

Post by Ruthard Baudach
Dear Gaute,
Warning! I never made patches before, so have a close look on this one
before messing anything up.
Attached is my first attempt at creating a patch for
sup/lib/sup/buffer.rb adding a comment for the dialog functions

Thanks,

I've applied the changes in commit 9cb10ec [0]. It is best if you
send the patches using either git format-patch or as a pull request on
github. That way you get all the information into the commit and it is
easy to apply for me.

Check out the wiki under Contributing [1] and look for format-patch in
git docs [2]. Also, make sure you don't add any stray whitspaces at the
end of lines.

Cheers, Gaute

[0] https://github.com/sup-heliotrope/sup/commit/9cb10eccda93cd36389bd5cc6515e3766d2f1bc0
[1] https://github.com/sup-heliotrope/sup/wiki/Contributing
[2] http://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project