zonuexe / right-click-context

Emacs Right Click Context menu
https://www.emacswiki.org/emacs/ZonuExe
60 stars 5 forks source link

Fixed checkdoc error. #4

Closed jcs090218 closed 5 years ago

jcs090218 commented 5 years ago

Small things fixed.

zonuexe commented 5 years ago

@jcs090218 Thank you for contribution. But unfortunately this patch does not solve the problem.

Doc comment in Emacs Lisp prefers ` and ' pair for quoting. It is a strange custom of the previous days of Unicode, but also in today's Emacs Lisp.

スクリーンショット 2019-05-24 20 17 37

Certainly, Checkdoc is warned at that point, but the good way to suppress it is not to wrap it in `…` like Markdown.


Checkdoc says:

Add quotes around Lisp symbol `right-click-context-mode'

Yes Mum, as you say.

Disambiguate right-click-context-mode by preceding w/ function,command,variable,option or symbol.

Emacs minor modes usually define interactive functions and variables of the same name. Therefore, Checkdoc considers just right-click-context-mode to be ambiguous.

The proposed revisions proposed by Checkdoc are:

@@ -65,7 +65,7 @@
   :group 'convenience)

 (defcustom right-click-context-mode-lighter " RightClick"
-  "Lighter displayed in mode line when `right-click-context-mode' is enabled."
+  "Lighter displayed in mode line when function `right-click-context-mode' is enabled."
   :group 'right-click-context
   :type 'string)

@@ -80,7 +80,7 @@
   (let ((map (make-sparse-keymap)))
     (define-key map (kbd "<mouse-3>") #'right-click-context-click-menu)
     map)
-  "Keymap used in `right-click-context-mode'.")
+  "Keymap used in function `right-click-context-mode'.")

 (defcustom right-click-context-global-menu-tree
   '(("Copy" :call (kill-ring-save (region-beginning) (region-end))

We know that *-mode is just a command, prefixing the function in turn causes confusion for the user. Therefore, I think that I do not need any prefix.

jcs090218 commented 5 years ago

No worry :D, I just feel hampered every time try to contribute to this project. All good!