Skip to content

Commit

Permalink
chore(melpa): add more information in commentary
Browse files Browse the repository at this point in the history
This information is used to generate description on MELPA
  • Loading branch information
gagbo committed Apr 25, 2021
1 parent 80d7be2 commit c4c0426
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions consult-lsp.el
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,30 @@

;;; Commentary:
;; Provides LSP-mode related commands for consult

;; TODO: Use a custom format for the propertized candidates
;; TODO: Check the properties in LSP to see how sources should be used
;;
;; The commands are autoloaded so you don't need to require anything to make them
;; available. Just use M-x and go!
;;
;;;; Diagnostics
;; M-x consult-lsp-diagnostics provides a view of all diagnostics in the current
;; workspace (or all workspaces if passed a prefix argument).
;;
;; You can use prefixes to filter diagnostics per severity, and
;; previewing/selecting a candidate will go to it directly.
;;
;;;; Symbols
;; M-x consult-lsp-symbols provides a selection/narrowing command to search
;; and go to any arbitrary symbol in the workspace (or all workspaces if
;; passed a prefix argument).
;;
;; You can use prefixes as well to filter candidates per type, and
;; previewing/selecting a candidate will go to it.
;;
;;;; Contributions
;; Possible contributions for ameliorations include:
;; - using a custom format for the propertized candidates
;; - checking the properties in LSP to see how diagnostic-sources should be used
;; - checking the properties in LSP to see how symbol-sources should be used
;;; Code:

(require 'consult)
Expand Down

0 comments on commit c4c0426

Please sign in to comment.