Skip to content

Commit 869e731

Browse files
committed
Fix checkdoc warnings
1 parent 7f4770a commit 869e731

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

psci.el

+10-7
Original file line numberDiff line numberDiff line change
@@ -59,22 +59,22 @@
5959
"Buffer name of the psci buffer.")
6060

6161
(defcustom psci/purs-path "purs"
62-
"Path to the `purs' binary"
62+
"Path to the \"purs\" binary."
6363
:group 'psci
6464
:type 'string)
6565

6666
(defcustom psci/psc-package-path "psc-package"
67-
"Path to the `psc-package' binary."
67+
"Path to the \"psc-package\" binary."
6868
:group 'psci
6969
:type 'string)
7070

7171
(defcustom psci/spago-path "spago"
72-
"Path to the `spago' binary."
72+
"Path to the \"spago\" binary."
7373
:group 'psci
7474
:type 'string)
7575

7676
(defcustom psci/arguments '("src/**/*.purs" "bower_components/purescript-*/src/**/*.purs")
77-
"Commandline arguments to pass to `psci' function."
77+
"Command-line arguments to pass to `psci' function."
7878
:group 'psci
7979
:type '(repeat string))
8080

@@ -95,7 +95,7 @@ Beware, can return nil if no .psci file is found."
9595
(format "*%s*" buffer-name))
9696

9797
(defun psci/--file-content (filename)
98-
"Load the FILENAME's content as a string.
98+
"Load FILENAME's content as a string.
9999
When FILENAME is nil or not a real file, returns nil."
100100
(when (and filename (file-exists-p filename))
101101
(with-temp-buffer
@@ -116,6 +116,7 @@ When FILENAME is nil or not a real file, returns nil."
116116
(match-string 1))))
117117

118118
(defun psci/--get-psc-package-sources! ()
119+
"Find extra source path globs using purescript package tools,if they appear to be used."
119120
(cond
120121
((file-exists-p "psc-package.json")
121122
(process-lines (psci/--executable-find-relative psci/psc-package-path) "sources"))
@@ -134,8 +135,10 @@ Otherwise, just return PATH."
134135

135136
;;;###autoload
136137
(defun psci (project-root-folder)
137-
"Run an inferior instance of `psci' inside Emacs.
138-
Relies on .psci file for determining the project's root folder."
138+
"Run an inferior instance of \"psci\" inside Emacs, in PROJECT-ROOT-FOLDER.
139+
If not supplied, the root folder will be guessed using
140+
`projectile-project-root' (if available), otherwise it will
141+
default to the current buffer's directory."
139142
(interactive (list (read-directory-name "Project root? "
140143
(psci/--project-root!))))
141144
(let* ((default-directory project-root-folder)

0 commit comments

Comments
 (0)