Skip to content

Commit c990a4f

Browse files
committed
Improve docstrings a bit
1 parent e644b7a commit c990a4f

File tree

2 files changed

+14
-5
lines changed

2 files changed

+14
-5
lines changed

haskell-completions.el

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -300,15 +300,23 @@ PREFIX should be a list such one returned by
300300

301301

302302
(defun haskell-completions-completion-at-point ()
303-
"Provide a list of completion candidates.
304-
This function is supposed to be used in non-interactive context.
305-
It provides completions for haskell keywords, language pragmas,
303+
"Provide completion list for thing at point.
304+
This function is used in non-interactive `haskell-mode'. It
305+
provides completions for haskell keywords, language pragmas,
306306
GHC's options, and language extensions, but not identifiers."
307307
(let ((prefix (haskell-completions-grab-prefix)))
308308
(haskell-completions--simple-completions prefix)))
309309

310310
(defun haskell-completions-sync-repl-completion-at-point ()
311-
"A `completion-at-point' function using the current haskell process.
311+
"A completion function used in `interactive-haskell-mode'.
312+
Completion candidates are provided quering current haskell
313+
process, that is sending `:complete repl' command.
314+
315+
Completes all possible things: everything that can be completed
316+
with non-interactive function
317+
`haskell-completions-completion-at-point' plus identifier
318+
completions.
319+
312320
Returns nil if no completions available."
313321
(let ((prefix-data (haskell-completions-grab-prefix)))
314322
(when prefix-data

haskell-interactive-mode.el

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1016,7 +1016,8 @@ don't care when the thing completes as long as it's soonish."
10161016
(remove-overlays))))
10171017

10181018
(defun haskell-interactive-mode-completion-at-point-function ()
1019-
"Offer completions for partial expression between prompt and point"
1019+
"Offer completions for partial expression between prompt and point.
1020+
This completion function is used in interactive REPL buffer itself."
10201021
(when (haskell-interactive-at-prompt)
10211022
(let* ((process (haskell-interactive-process))
10221023
(inp (haskell-interactive-mode-input-partial))

0 commit comments

Comments
 (0)