Merge pull request #11 from jcs-elpa/docs

chore(notes): add TODO notes, fix typo and update copyright year

Author: jcs090218

README.md

@@ -220,7 +220,7 @@ Function takes 2 arguments, `node` and `offset`.
 
 * `node` - the targeting tree-sitter node; in this example, `block` will be the
 targeting node.
-* `offset` - (optiona) a cons consist of two integers. This is handy when you have
+* `offset` - (optional) a cons consist of two integers. This is handy when you have
 a similar rule with little of positioning adjustment.
 
 `tree-sitter-[lang]` parsers are generally integrated with different authors,

ts-fold-indicators.el

@@ -1,6 +1,6 @@
 ;;; ts-fold-indicators.el --- Display indicators for folding range  -*- lexical-binding: t; -*-
 
-;; Copyright (C) 2021  Shen, Jen-Chieh
+;; Copyright (C) 2021-2022  Shen, Jen-Chieh
 ;; Created date 2021-10-04 20:03:12
 
 ;; This file is NOT part of GNU Emacs.

ts-fold-parsers.el

@@ -1,6 +1,6 @@
 ;;; ts-fold-parsers.el --- Adapter layer to Tree-Sitter  -*- lexical-binding: t; -*-
 
-;; Copyright (C) 2021  Shen, Jen-Chieh
+;; Copyright (C) 2021-2022  Shen, Jen-Chieh
 ;; Created date 2021-10-04 17:45:48
 
 ;; This file is NOT part of GNU Emacs.
@@ -33,6 +33,8 @@
 ;; (@* "Externals" )
 ;;
 
+;; TODO(everyone): keep the forward declared alphabetically sorted
+
 (declare-function ts-fold-range-seq "ts-fold.el")
 (declare-function ts-fold-range-line-comment "ts-fold.el")
 (declare-function ts-fold-range-block-comment "ts-fold.el")
@@ -51,6 +53,8 @@
 ;; (@* "Parsers" )
 ;;
 
+;; TODO(everyone): keep the function alphabetically sorted
+
 (defun ts-fold-parsers-agda ()
   "Rule sets for Agda."
   '(()))

ts-fold-summary.el

@@ -1,6 +1,6 @@
 ;;; ts-fold-summary.el --- Extract summary from fold region  -*- lexical-binding: t; -*-
 
-;; Copyright (C) 2021  Shen, Jen-Chieh
+;; Copyright (C) 2021-2022  Shen, Jen-Chieh
 ;; Created date 2021-10-04 16:59:22
 
 ;; This file is NOT part of GNU Emacs.
@@ -193,6 +193,7 @@ type of content by checking the word boundary's existence."
               summary (propertize summary 'face 'ts-fold-replacement-face))))
     summary))
 
+;; TODO(everyone): keep this alist alphabetically sorted
 (defcustom ts-fold-summary-parsers-alist
   `((actionscript-mode . ts-fold-summary-javadoc)
     (bat-mode          . ts-fold-summary-batch)

ts-fold-util.el

@@ -1,6 +1,6 @@
 ;;; ts-fold-util.el --- Utility module  -*- lexical-binding: t; -*-
 
-;; Copyright (C) 2021  Shen, Jen-Chieh
+;; Copyright (C) 2021-2022  Shen, Jen-Chieh
 ;; Created date 2021-10-04 20:19:42
 
 ;; This file is NOT part of GNU Emacs.

ts-fold.el

@@ -1,7 +1,7 @@
 ;;; ts-fold.el --- Code folding using tree-sitter  -*- lexical-binding: t; -*-
 
 ;; Copyright (C) 2021  Junyi Hou
-;; Copyright (C) 2021  Shen, Jen-Chieh
+;; Copyright (C) 2021-2022  Shen, Jen-Chieh
 
 ;; Created date 2021-08-11 14:12:37
 
@@ -61,6 +61,8 @@
 
 The alist is in form of (major-mode . (foldable-node-type)).")
 
+;; TODO(everyone): This is a bit messy, but try to keep this alist
+;; alphabetically sorted
 (defcustom ts-fold-range-alist
   `((agda-mode       . ,(ts-fold-parsers-agda))
     (sh-mode         . ,(ts-fold-parsers-bash))