branch: externals/valign
commit 586bba289acb348d60e35bbead9747512c2dc0dc
Author: Feng Shu <[email protected]>
Commit: Feng Shu <[email protected]>
Fix package-lint and checkdoc warns
* valign.el: Add URL, Version, Keywords and Package-Requires.
(valign--pixel-width-from-to, valign--beginning-of-table)
(valign--end-of-table, valign--align-separator-row): Fix package-lint and
checkdoc warns
---
valign.el | 24 ++++++++++++++----------
1 file changed, 14 insertions(+), 10 deletions(-)
diff --git a/valign.el b/valign.el
index d7320f4..13976d2 100644
--- a/valign.el
+++ b/valign.el
@@ -1,6 +1,10 @@
;;; valign.el --- Visually align tables -*- lexical-binding: t; -*-
;; Author: Yuan Fu <[email protected]>
+;; URL: https://github.com/casouri/valign
+;; Version: 0.1.0
+;; Keywords: convenience
+;; Package-Requires: ((emacs "26.0"))
;;; This file is NOT part of GNU Emacs
@@ -8,15 +12,15 @@
;;
;; This package provides visual alignment for Org tables on GUI Emacs.
;; It can properly align tables containing variable-pitch font, CJK
-;; characters and images. In the meantime, the text-based alignment
+;; characters and images. In the meantime, the text-based alignment
;; generated by Org mode is left untouched.
;;
-;; To use this package, load it and run M-x valign-setup RET. And any
-;; Org tables in Org mode should be automatically aligned. If you want
+;; To use this package, load it and run M-x valign-setup RET. And any
+;; Org tables in Org mode should be automatically aligned. If you want
;; to align a table manually, run M-x valign-table RET on a Org table.
;;
;; Valign provides two styles of separator, |-----|-----|, and
-;; | |. Customize ‘valign-separator-row-style’ to set a
+;; | |. Customize ‘valign-separator-row-style’ to set a
;; style.
;;; Code:
@@ -77,7 +81,7 @@ Return nil if not in a cell."
(defun valign--glyph-width-at-point (&optional point)
"Return the pixel width of the glyph at POINT.
-The buffer has to be visible. If point is at an image, this
+The buffer has to be visible. If point is at an image, this
function doens’t return the image’s width, but the underlining
character’s glyph width."
(let* ((p (or point (point))))
@@ -88,7 +92,7 @@ character’s glyph width."
(defun valign--pixel-width-from-to (from to)
"Return the width of the glyphs from FROM (inclusive) to TO (exclusive).
-The buffer has to be visible. FROM has to be less than TO. Unlike
+The buffer has to be visible. FROM has to be less than TO. Unlike
‘valign--glyph-width-at-point’, this function can properly
calculate images pixel width."
(let ((width 0))
@@ -202,7 +206,7 @@ Start from point, stop at LIMIT."
(defun valign--beginning-of-table ()
"Go backward to the beginning of the table at point.
-Assumes point is on a table. Return nil if failed, point
+Assumes point is on a table. Return nil if failed, point
otherwise."
(beginning-of-line)
(if (not (eq (char-after) ?|))
@@ -215,7 +219,7 @@ otherwise."
(defun valign--end-of-table ()
"Go forward to the end of the table at point.
-Assumes point is on a table. Return nil if failed, point
+Assumes point is on a table. Return nil if failed, point
otherwise."
(beginning-of-line)
(if (not (eq (char-after) ?|))
@@ -279,7 +283,7 @@ Supposed to be called from jit-lock."
(defun valign--align-separator-row (total-width)
"Align the separator row (|---+---|) as “| |”.
-Assumes the point is after the left bar (“|”). TOTAL-WIDTH is the
+Assumes the point is after the left bar (“|”). TOTAL-WIDTH is the
pixel width counting from the left of the left bar to the left of
the right bar."
(let ((p (point)))
@@ -323,7 +327,7 @@ the position for the right bar (“|”)."
(defcustom valign-separator-row-style 'multi-column
"The style of the separator row of a table.
Valign can render it as “| |”
-or as “|-----|-----|”. Set this option to 'single-column
+or as “|-----|-----|”. Set this option to 'single-column
for the former, and 'multi-column for the latter."
:type 'symbol
:group 'valign)
