branch: elpa/raku-mode
commit a82a14ceb2fd7e164b26cb983afaf2b6a73979ec
Author: Hinrik Örn Sigurðsson <[email protected]>
Commit: Hinrik Örn Sigurðsson <[email protected]>
Better doc string for perl6-magic-matcher
---
perl6-detect.el | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/perl6-detect.el b/perl6-detect.el
index 05ed2fe8ae..3a5ce9cbbc 100644
--- a/perl6-detect.el
+++ b/perl6-detect.el
@@ -25,7 +25,13 @@
;;;###autoload
(defun perl6-magic-matcher ()
- "Return non-nil if the current buffer is probably a Perl 6 file."
+ "Check if the current buffer is a Perl 6 file.
+
+Only looks at a buffer if it has a file extension of .t, .pl, or .pm.
+
+Scans the buffer (to a maximum of 4096 chars) for the first non-comment,
+non-whitespace line. Returns t if that line looks like Perl 6 code,
+nil otherwise."
(let ((case-fold-search nil))
(when (and (stringp buffer-file-name)
(string-match "\\.\\(?:t\\|p[lm]\\)\\'" buffer-file-name))
