[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/sql-indent d56faed 06/13: Updated documentation
From: |
Stefan Monnier |
Subject: |
[elpa] externals/sql-indent d56faed 06/13: Updated documentation |
Date: |
Sun, 11 Feb 2018 22:24:13 -0500 (EST) |
branch: externals/sql-indent
commit d56faed9bb7f965574731bcb216e26f8bd3141ab
Author: Alex Harsanyi <address@hidden>
Commit: Alex Harsanyi <address@hidden>
Updated documentation
* Simplified CONTRIBUTING.md -- removed information that is available
elsewhere
* Fixed a type in the user manual, `sql-indent.org` specifying the
wrong hook
name for the customization
* Clarified test naming conventions in `sql-indent-test.el`
---
CONTRIBUTING.md | 32 ++++++--------------------------
sql-indent-test.el | 11 +++++++----
sql-indent.org | 2 +-
3 files changed, 14 insertions(+), 31 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ea722ec..9fc97e7 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-# If you have a question
+# If you have a question or found a bug
To ask a question about the package, please please [create an
issue][gh-issue-link] containing a description of what you are trying to do
@@ -6,15 +6,11 @@ and consider providing sample SQL code if appropriate. There
is also a
[manual](./sql-indent.org) which provides information about customizing the
indentation rules.
-
-# If you found a bug
-
If you found a bug in the SQL indentation code, or don't know how to configure
the indentation rules to suit your preferences, please [create an
issue][gh-issue-link]. Please provide a sample SQL code snippet that
demonstrates the problem.
-
# Submitting code changes
The preferred way to accept contributions is to submit a pull request using
@@ -33,26 +29,11 @@ you want to proceed with the assignment.
## Automated test suite
There's an automated test suite which is used to ensure we don't re-introduce
-bugs that that were already fixed. Please run the test suite to test that
-your changes did not break anything. You can load that the
-[sql-indent-test.el](./sql-indent-test.el) file, than run them inside Emacs
-using the command:
-
- M-x ert RET "^sqlind-" RET
-
-Tests can also be run in batch mode using the following command:
-
- emacs -batch -Q --no-site-file -L . -l sql-indent-test.el -f
ert-run-tests-batch-and-exit
-
-If you fix the problem with the indentation, please provide an automated test
-for the fixes. The file [sql-indent-test.el](./sql-indent-test.el) contains a
-description on how to do that.
-
-The test files are named after the pull request number. For example, for pull
-request #49, the test files are named `pr49.sql` for the sample SQL code and
-`pr49-syn.eld` for the syntax symbol files. This means you will need to
-create the pull request first, and once you know the number, add or update the
-test file names. Sorry about that.
+bugs that that were already fixed. If you fix the problem with the
+indentation, please provide an automated test for your fixes and add it to the
+test suite. The "Commentary" section in the
+[sql-indent-test.el](./sql-indent-test.el) file contains a description on how
+to add and run tests.
## Other considerations for the pull request
@@ -63,7 +44,6 @@ Once you submit the pull request, an automated build will
start and will run
the unit tests, please verify that the build succeeds and fix any issues if
the build failed.
-
[elpa-link]: http://elpa.gnu.org/packages/
[copy-papers-link]:
http://www.gnu.org/prep/maintain/html_node/Copyright-Papers.html
[legally-link]:
http://www.gnu.org/prep/maintain/html_node/Legally-Significant.html#Legally-Significant
diff --git a/sql-indent-test.el b/sql-indent-test.el
index a14ddf9..cb91d30 100644
--- a/sql-indent-test.el
+++ b/sql-indent-test.el
@@ -75,10 +75,13 @@
;;
;;;; NAMING CONVENTION
;;
-;; If there's a problem report on GitHub (issue or pull request), use the
-;; issue number as the "tag" for the test. For example, a test that addresses
-;; issue number 30 will have a tag "pr30", otherwise choose a short tag for
-;; the test. With this tag the following files are created:
+;; If there's a problem report on GitHub, use the issue number as the "tag"
+;; for the test. For example, a test that addresses issue number 30 will have
+;; a tag "pr30". If there is no issue on GitHub, use the pull request number.
+;; In this case you will have to create the pull request first, so you know
+;; the number, before you can add the tests -- sorry about that.
+;;
+;; With the issue or pull request tag the following files are created:
;;
;; * "test-data/pr30.sql" -- contains the sample SQL code that is verified
;;
diff --git a/sql-indent.org b/sql-indent.org
index 28c8608..43ecec5 100644
--- a/sql-indent.org
+++ b/sql-indent.org
@@ -123,7 +123,7 @@ You can add the following code to your init file:
(update-clause 0)
,@sqlind-default-indentation-offsets-alist))
- (add-hook 'sql-minor-mode-hook
+ (add-hook 'sqlind-minor-mode-hook
(lambda ()
(setq sqlind-indentation-offsets-alist
my-sql-indentation-offsets-alist)))
- [elpa] externals/sql-indent updated (c3d49c6 -> 44841a8), Stefan Monnier, 2018/02/11
- [elpa] externals/sql-indent bd39d07 10/13: add explanation on how `sqlind-beginning-of-block` works, Stefan Monnier, 2018/02/11
- [elpa] externals/sql-indent 2c9c17f 07/13: Fix typo in sql-indent.org. (#56), Stefan Monnier, 2018/02/11
- [elpa] externals/sql-indent 283116d 04/13: Correct the adjustment of indentation for operators in select (#52), Stefan Monnier, 2018/02/11
- [elpa] externals/sql-indent 51b17d6 01/13: Update README with instructions on how to install from GNU ELPA, Stefan Monnier, 2018/02/11
- [elpa] externals/sql-indent 0bca299 12/13: Fix travis build. (#58), Stefan Monnier, 2018/02/11
- [elpa] externals/sql-indent 44841a8 13/13: Add .elpaignore file, Stefan Monnier, 2018/02/11
- [elpa] externals/sql-indent 1b4d0e8 03/13: Add CONTRIBUTING.md file (#51), Stefan Monnier, 2018/02/11
- [elpa] externals/sql-indent 3ee7f95 08/13: Fix various typos here and there. (#57), Stefan Monnier, 2018/02/11
- [elpa] externals/sql-indent d56faed 06/13: Updated documentation,
Stefan Monnier <=
- [elpa] externals/sql-indent 9f716f6 09/13: Recognize PostgreSQL $$ quote syntax, #54 (#55), Stefan Monnier, 2018/02/11
- [elpa] externals/sql-indent 8a1c4ec 05/13: Correct indentation of column continuation with operators. (#53), Stefan Monnier, 2018/02/11
- [elpa] externals/sql-indent 1efac21 11/13: Update sql-indent.el to version 1.1, Stefan Monnier, 2018/02/11
- [elpa] externals/sql-indent 146655b 02/13: Add new indentation function for select columns. (#50), Stefan Monnier, 2018/02/11