Skip to content

Commit cb8d01a

Browse files
committed
chore: satisfy check-doc and package-lint
1 parent abb98ab commit cb8d01a

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

leetcode.el

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,7 @@ VALUE should be the referer."
149149
(leetcode--maybe-csrf-token))
150150

151151
(defun leetcode--credentials ()
152+
"Receive user account and password."
152153
(let ((auth-source-creation-prompts
153154
'((user . "LeetCode user: ")
154155
(secret . "LeetCode password for %u: ")))
@@ -166,6 +167,7 @@ VALUE should be the referer."
166167
(plist-get found :save-function)))))
167168

168169
(defun leetcode--multipart-form-data (name value)
170+
"Generate multipart form data with NAME and VALUE."
169171
`("file"
170172
("name" . ,name)
171173
("filedata" . ,value)
@@ -428,8 +430,8 @@ Return a list of rows, each row is a vector:
428430

429431
;;;###autoload
430432
(defun leetcode ()
431-
"A wrapper for leetcode--async, because emacs-aio can not be
432-
autoloaded. see: https://github.com/skeeto/emacs-aio/issues/3"
433+
"A wrapper for `leetcode--async', because emacs-aio can not be autoloaded.
434+
see: https://github.com/skeeto/emacs-aio/issues/3."
433435
(interactive)
434436
(leetcode--async))
435437

@@ -680,7 +682,7 @@ following possible value:
680682
(leetcode--loading-mode -1))))))
681683

682684
(defun leetcode--problem-link (title)
683-
"Generate problem link from title."
685+
"Generate problem link from TITLE."
684686
(concat leetcode--base-url "/problems/" (leetcode--slugify-title title)))
685687

686688
(aio-defun leetcode-show-current-problem ()
@@ -730,12 +732,12 @@ Get current entry by using `tabulated-list-get-entry' and use
730732
(switch-to-buffer (current-buffer))))))
731733

732734
(defun leetcode--kill-buff-and-delete-window (buf)
733-
"Kill buff and delete its window"
735+
"Kill BUF and delete its window."
734736
(delete-windows-on buf t)
735737
(kill-buffer buf))
736738

737739
(defun leetcode-quit ()
738-
"Close and delete leetcode related buffers and windows"
740+
"Close and delete leetcode related buffers and windows."
739741
(interactive)
740742
(leetcode--kill-buff-and-delete-window (get-buffer leetcode--buffer-name))
741743
(leetcode--kill-buff-and-delete-window (get-buffer leetcode--description-buffer-name))
@@ -754,8 +756,8 @@ python3, ruby, rust, scala, swift.")
754756
mysql, mssql, oraclesql.")
755757

756758
(defvar leetcode--lang leetcode-prefer-language
757-
"LeetCode programming language or sql for current problem
758-
internally. Default is programming language.")
759+
"LeetCode programming language or sql for current problem internally.
760+
Default is programming language.")
759761

760762
(defconst leetcode--lang-suffixes
761763
'(("c" . ".c") ("cpp" . ".cpp") ("csharp" . ".cs")
@@ -769,7 +771,7 @@ c, cpp, csharp, golang, java, javascript, kotlin, php, python,
769771
python3, ruby, rust, scala, swift, mysql, mssql, oraclesql.")
770772

771773
(defun leetcode--set-lang (snippets)
772-
"Set `leetcode--lang' based on langSlug in snippets."
774+
"Set `leetcode--lang' based on langSlug in SNIPPETS."
773775
(setq leetcode--lang
774776
(if (seq-find (lambda (s)
775777
(equal (alist-get 'langSlug s)
@@ -868,6 +870,7 @@ for current problem."
868870

869871
(define-minor-mode leetcode--loading-mode
870872
"Minor mode to showing leetcode loading status."
873+
:require 'leetcode
871874
:lighter leetcode--loading-lighter
872875
:group 'leetcode
873876
:global t

0 commit comments

Comments
 (0)