Skip to content

Commit 167a16e

Browse files
xiongtxbbatsov
authored andcommitted
Add section on tools (#43)
Partially address #39.
1 parent 80e6e24 commit 167a16e

File tree

1 file changed

+24
-16
lines changed

1 file changed

+24
-16
lines changed

README.md

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -33,18 +33,21 @@ You can generate a PDF or an HTML copy of this guide using
3333

3434
## Table of Contents
3535

36-
* [Source Code Layout & Organization](#source-code-layout--organization)
37-
* [Syntax](#syntax)
38-
* [Naming](#naming)
39-
* [Strings](#strings)
40-
* [Macros](#macros)
41-
* [Macro Declarations](#macro-declarations)
42-
* [Anonymous (lambda) functions](#anonymous-lambda-functions)
43-
* [Loading and Autoloading](#loading-and-autoloading)
44-
* [Comments](#comments)
45-
* [Comment Annotations](#comment-annotations)
46-
* [Docstrings](#docstrings)
47-
* [Existential](#existential)
36+
- [Source Code Layout & Organization](#source-code-layout--organization)
37+
- [Syntax](#syntax)
38+
- [Naming](#naming)
39+
- [Macros](#macros)
40+
- [Functions](#functions)
41+
- [Macro Declarations](#macro-declarations)
42+
- [Loading and Autoloading](#loading-and-autoloading)
43+
- [Comments](#comments)
44+
- [Comment Annotations](#comment-annotations)
45+
- [Docstrings](#docstrings)
46+
- [Tools](#tools)
47+
- [Existential](#existential)
48+
- [Contributing](#contributing)
49+
- [License](#license)
50+
- [Spread the Word](#spread-the-word)
4851

4952
## Source Code Layout & Organization
5053

@@ -658,10 +661,15 @@ you are helping to continue that tradition!
658661
...)
659662
```
660663

661-
* Emacs' built-in utility, Checkdoc, can automatically check
662-
docstrings for adherence to coding conventions with the built-in
663-
Checkdoc utility. Many in the Emacs community use Checkdoc by way of
664-
[Flycheck](http://flycheck.readthedocs.org/en/latest/).
664+
## Tools
665+
666+
* Use `checkdoc` to check for style issues
667+
* Many in the Emacs community use `checkdoc`
668+
with [Flycheck](http://flycheck.readthedocs.org/en/latest/).
669+
* Use [`package-lint`](https://github.com/purcell/package-lint) to check
670+
packages before submission to repositories such
671+
as [MELPA](https://melpa.org/).
672+
* See the `package-lint` README about integration with [`flycheck`](http://www.flycheck.org/en/latest/).
665673

666674
## Existential
667675

0 commit comments

Comments
 (0)