Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
raxod502 committed Apr 4, 2020
1 parent 94b2bfd commit 42ceabd
Showing 1 changed file with 16 additions and 33 deletions.
49 changes: 16 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ mode](https://www.gnu.org/software/emacs/manual/html_node/emacs/Matching.html),
and [Smartparens](https://github.com/Fuco1/smartparens). The package
is called Dumbparens as a response to Smartparens, which I feel tries
to be much too smart for its own good, resulting in a host of bugs,
performance issues, and behavior that can only be described as just
plain zany (see below). Dumbparens has the design philosophy of: try
to do as little as possible, and **always** do something reasonable.
performance issues, and inexplicable behavior. Dumbparens has the
design philosophy of: try to do as little as possible, and **always**
do something reasonable.

Documentation will come when the basic features have been implemented.
Usage is as follows. First install with
Expand All @@ -21,36 +21,19 @@ Usage is as follows. First install with

Then type `M-x dumbparens-mode` or `M-x dumbparens-global-mode`.

To run the tests, evaluate the contents of `dumbparens-tests.el` and
then type `M-x dumbparens-run-all-tests`. Since Dumbparens has a goal
of **always** doing something reasonable, any unreasonable behavior
will result in a slap on the wrist and a new regression test.
To run the tests, you have two options:

### What does "zany" mean?
1. From Emacs, evaluate the contents of `dumbparens-tests.el` and then
type `M-x dumbparens-run-all-tests`.
2. From the command line, run `make test`.

Suppose we enable `smartparens-mode` and `delete-selection-mode`, and
we have this buffer of text:
Since Dumbparens has a goal of **always** doing something reasonable,
any unreasonable behavior will result in a slap on the wrist and a new
regression test.

```
Suppose we enable `smartparens-mode` and `delete-selection-mode`, and
we have this buffer of text
```

Now suppose we select the entire buffer and type the backslash key
`\`. What *should* happen is the region is deleted and replaced with a
backslash:

```
\
```

However with `smartparens-mode` enabled, the following is what we get
instead:

```
\Suppose we enable `smartparens-mode` and `delete-selection-mode`, and
we have this buffer of text\"\" \(\) \{\} \\(\\)
```

Okay, to be fair, after you perform a subsequent command in the
buffer, everything but the backslash gets deleted, but ... what???
Note that there are also various linters, which you can run along with
the unit tests by means of `make lint`.
[CircleCI](https://circleci.com/gh/raxod502/dumbparens) will
automatically run this against all supported Emacs versions. You can
easily test for yourself by using `make docker VERSION=25.1` or
analogous to use the appropriate version.

0 comments on commit 42ceabd

Please sign in to comment.