[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/bnf-mode c90b14d 26/74: Correct documentation to follow
From: |
Stefan Monnier |
Subject: |
[elpa] externals/bnf-mode c90b14d 26/74: Correct documentation to follow code style guide. |
Date: |
Thu, 9 May 2019 08:27:46 -0400 (EDT) |
branch: externals/bnf-mode
commit c90b14d1d9b868784f3dda072a5120c2b00b288c
Author: Serghei Iakovlev <address@hidden>
Commit: Serghei Iakovlev <address@hidden>
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:
- [elpa] externals/bnf-mode b18b10c 05/74: Implemented font locking, (continued)
- [elpa] externals/bnf-mode b18b10c 05/74: Implemented font locking, Stefan Monnier, 2019/05/09
- [elpa] externals/bnf-mode 388206f 09/74: Correct copyright date, Stefan Monnier, 2019/05/09
- [elpa] externals/bnf-mode 3beded6 15/74: Rule names are case insensitive. Added test., Stefan Monnier, 2019/05/09
- [elpa] externals/bnf-mode af8cf6d 18/74: Correct change log [ci skip], Stefan Monnier, 2019/05/09
- [elpa] externals/bnf-mode fd83621 20/74: Bump version, Stefan Monnier, 2019/05/09
- [elpa] externals/bnf-mode f917836 23/74: Change default goal for make, Stefan Monnier, 2019/05/09
- [elpa] externals/bnf-mode ed24bee 21/74: Bumb version, Stefan Monnier, 2019/05/09
- [elpa] externals/bnf-mode a7df2dd 17/74: Fontify sequences, Stefan Monnier, 2019/05/09
- [elpa] externals/bnf-mode defc412 11/74: Amended description and docs, Stefan Monnier, 2019/05/09
- [elpa] externals/bnf-mode aa2c7a2 30/74: Correct change log formatting [ci skip], Stefan Monnier, 2019/05/09
- [elpa] externals/bnf-mode c90b14d 26/74: Correct documentation to follow code style guide.,
Stefan Monnier <=
- [elpa] externals/bnf-mode a3a77e3 29/74: In the BNF there are no grouping brackets except angle ones. Fixed, Stefan Monnier, 2019/05/09
- [elpa] externals/bnf-mode 1698dc8 39/74: Improved documentation, Stefan Monnier, 2019/05/09
- [elpa] externals/bnf-mode 64a32ba 42/74: Cleaned up Makefile, Stefan Monnier, 2019/05/09
- [elpa] externals/bnf-mode a53ade1 24/74: Fixed BNF rule name definition to follow ALGOL 60 report, Stefan Monnier, 2019/05/09
- [elpa] externals/bnf-mode 65bfadc 65/74: Fixed orthodox comments regexp, Stefan Monnier, 2019/05/09
- [elpa] externals/bnf-mode e2f8bfa 53/74: Added support of ; character to use in terminals, Stefan Monnier, 2019/05/09
- [elpa] externals/bnf-mode 3a46f17 36/74: Correct documentation, Stefan Monnier, 2019/05/09
- [elpa] externals/bnf-mode f99de60 47/74: Cleaned up Makefile, Stefan Monnier, 2019/05/09
- [elpa] externals/bnf-mode 7bbf329 49/74: Added comment-start-skip to help comment commands recognize comments, Stefan Monnier, 2019/05/09
- [elpa] externals/bnf-mode 00a0543 50/74: Removed not used tests macro, Stefan Monnier, 2019/05/09