Skip to content

Commit

Permalink
Add section on tools
Browse files Browse the repository at this point in the history
Partially address bbatsov#39.
  • Loading branch information
Tianxiang Xiong committed Apr 5, 2017
1 parent 80e6e24 commit 490ccf5
Showing 1 changed file with 31 additions and 16 deletions.
47 changes: 31 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,18 +33,28 @@ You can generate a PDF or an HTML copy of this guide using

## Table of Contents

* [Source Code Layout & Organization](#source-code-layout--organization)
* [Syntax](#syntax)
* [Naming](#naming)
* [Strings](#strings)
* [Macros](#macros)
* [Macro Declarations](#macro-declarations)
* [Anonymous (lambda) functions](#anonymous-lambda-functions)
* [Loading and Autoloading](#loading-and-autoloading)
* [Comments](#comments)
* [Comment Annotations](#comment-annotations)
* [Docstrings](#docstrings)
* [Existential](#existential)
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-generate-toc again -->
**Table of Contents**

- [The Emacs Lisp Style Guide](#the-emacs-lisp-style-guide)
- [Table of Contents](#table-of-contents)
- [Source Code Layout & Organization](#source-code-layout--organization)
- [Syntax](#syntax)
- [Naming](#naming)
- [Macros](#macros)
- [Functions](#functions)
- [Macro Declarations](#macro-declarations)
- [Loading and Autoloading](#loading-and-autoloading)
- [Comments](#comments)
- [Comment Annotations](#comment-annotations)
- [Docstrings](#docstrings)
- [Tools](#tools)
- [Existential](#existential)
- [Contributing](#contributing)
- [License](#license)
- [Spread the Word](#spread-the-word)

<!-- markdown-toc end -->

## Source Code Layout & Organization

Expand Down Expand Up @@ -658,10 +668,15 @@ you are helping to continue that tradition!
...)
```

* Emacs' built-in utility, Checkdoc, can automatically check
docstrings for adherence to coding conventions with the built-in
Checkdoc utility. Many in the Emacs community use Checkdoc by way of
[Flycheck](http://flycheck.readthedocs.org/en/latest/).
## Tools

* Use `checkdoc` to check for style issues
* Many in the Emacs community use `checkdoc`
with [Flycheck](http://flycheck.readthedocs.org/en/latest/).
* Use [`package-lint`](https://github.com/purcell/package-lint) to check
packages before submission to repositories such
as [MELPA](https://melpa.org/).
* See the `package-lint` README about integration with [`flycheck`](http://www.flycheck.org/en/latest/).

## Existential

Expand Down

0 comments on commit 490ccf5

Please sign in to comment.