branch: externals/bnf-mode
commit c90b14d1d9b868784f3dda072a5120c2b00b288c
Author: Serghei Iakovlev <serg...@phalconphp.com>
Commit: Serghei Iakovlev <serg...@phalconphp.com>
Correct documentation to follow code style guide.
For more see Emacs documentation: D.6 Tips for Documentation Strings
---
README.org | 2 +-
bnf-mode.el | 23 +++++++++++------------
2 files changed, 12 insertions(+), 13 deletions(-)
diff --git a/README.org b/README.org
index c3f2ade..31070c8 100644
--- a/README.org
+++ b/README.org
@@ -16,7 +16,7 @@ Currently provides basic syntax and font-locking for BNF
files. BNF notation is
supported exactly form as it was first announced in the ALGOL 60 report.
EBNF and ABNF are not supported but in my plans for the near future.
-When developing this mode, the following RFCs were taken into account:
+When developing this mode, the following documents were taken into account:
- [[https://www.masswerk.at/algol60/report.htm][Revised Report on the
Algorithmic Language Algol 60]]
- [[https://tools.ietf.org/html/rfc822][RFC822]]: Standard for ARPA Internet
Text Messages
diff --git a/bnf-mode.el b/bnf-mode.el
index 4f1ba12..f078872 100644
--- a/bnf-mode.el
+++ b/bnf-mode.el
@@ -34,28 +34,27 @@
;; provides basic syntax and font-locking for BNF files. BNF notation is
;; supported exactly form as it was first announced in the ALGOL 60 report.
;;
-;; When developing this mode, the following RFCs were taken into account:
+;; When developing this mode, the following documents were taken into account:
;;
-;; - RFC822: Standard for ARPA Internet Text Messages [1]
-;; - RFC5234: Augmented BNF for Syntax Specifications: ABNF [2]
+;; - RFC822: Standard for ARPA Internet Text Messages
+;; (see URL `https://www.ietf.org/rfc/rfc822.txt')
+;; - RFC5234: Augmented BNF for Syntax Specifications: ABNF
+;; (see URL `https://www.ietf.org/rfc/rfc5234.txt')
;; - FRC7405: Case-Sensitive String Support in ABNF [3]
-;; - Revised Report on the Algorithmic Language Algol 60 [4]
-;;
-;; [1]: https://www.ietf.org/rfc/rfc822.txt
-;; [2]: https://www.ietf.org/rfc/rfc5234.txt
-;; [3]: https://www.ietf.org/rfc/rfc7405.txt
-;; [4]: https://www.masswerk.at/algol60/report.htm
+;; (see URL `https://www.ietf.org/rfc/rfc7405.txt')
+;; - Revised Report on the Algorithmic Language Algol 60
+;; (see URL `https://www.masswerk.at/algol60/report.htm')
;;
;; Usage: Put this file in your Emacs Lisp path (eg. site-lisp) and add to
;; your .emacs file:
;;
;; (require 'bnf-mode)
;;
-;; Bugs: Bug tracking is currently handled using the GitHub issue tracker at
-;; https://github.com/sergeyklay/bnf-mode/issues
+;; Bugs: Bug tracking is currently handled using the GitHub issue tracker
+;; (see URL `https://github.com/sergeyklay/bnf-mode/issues')
;;
;; History: History is tracked in the Git repository rather than in this file.
-;; See https://github.com/sergeyklay/bnf-mode/blob/master/CHANGELOG.org
+;; See URL `https://github.com/sergeyklay/bnf-mode/blob/master/CHANGELOG.org'
;;; Code:
