Skip to content

Commit a8f597b

Browse files
committed
Add minimal document to the header of the code
melpa/melpa#5427 (comment)
1 parent 5bef69e commit a8f597b

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

phpstan.el

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,31 @@
2626

2727
;; Static analyze for PHP code using PHPStan.
2828
;; https://github.com/phpstan/phpstan
29+
;;
30+
;; ## Instalation
31+
;;
32+
;; You need to get either the local PHP runtime or Docker and prepare for PHPStan.
33+
;; Please read the README for these details.
34+
;; https://github.com/emacs-php/phpstan.el/blob/master/README.org
35+
;;
36+
;; If you are a Flycheck user, activate it by selecting `phpstan`
37+
;; with `M-x flycheck-select-checker'.
38+
;;
39+
;; ## Directory local variables
40+
;;
41+
;; Put the following into .dir-locals.el files on the root directory of project.
42+
;; Each variable can read what is documented by `M-x describe-variables'.
43+
;;
44+
;; ((nil . ((php-project-root . git)
45+
;; (phpstan-executable . docker)
46+
;; (phpstan-working-dir . (root . "path/to/dir"))
47+
;; (phpstan-config-file . (root . "path/to/dir/phpstan-docker.neon"))
48+
;; (phpstan-level . 7))))
49+
;;
50+
;; If you want to know the directory variable specification, please refer to
51+
;; M-x info [Emacs > Customization > Variables] or the following web page.
52+
;; https://www.gnu.org/software/emacs/manual/html_node/emacs/Directory-Variables.html
53+
;;
2954

3055
;;; Code:
3156
(require 'php-project)

0 commit comments

Comments
 (0)