[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/buttercup 25cb350 089/340: Rename docs to be more easily u
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/buttercup 25cb350 089/340: Rename docs to be more easily understandable |
Date: |
Thu, 16 Dec 2021 14:59:10 -0500 (EST) |
branch: elpa/buttercup
commit 25cb3500c45cbc898952c961883da7f1ba01c85d
Author: Jorgen Schaefer <contact@jorgenschaefer.de>
Commit: Jorgen Schaefer <contact@jorgenschaefer.de>
Rename docs to be more easily understandable
See comments on #40
---
README.md | 4 ++--
docs/{usage.md => running-tests.md} | 4 ++--
docs/testrunners.md | 15 ---------------
docs/{introduction.md => writing-tests.md} | 0
4 files changed, 4 insertions(+), 19 deletions(-)
diff --git a/README.md b/README.md
index 7c5a662..36b7b53 100644
--- a/README.md
+++ b/README.md
@@ -16,7 +16,7 @@ The framework is heavily inspired by
## Example
-*Full article: [Introduction](docs/introduction.md)*
+*Full article: [Writing Tests](docs/writing-tests.md)*
A simple test looks like this.
@@ -28,7 +28,7 @@ A simple test looks like this.
## Installation and Usage
-*Full article: [Usage](docs/usage.md)*
+*Full article: [Running Tests](docs/running-tests.md)*
You can install buttercup from
[MELPA Stable](http://stable.melpa.org/). Add the following to your
diff --git a/docs/usage.md b/docs/running-tests.md
similarity index 96%
rename from docs/usage.md
rename to docs/running-tests.md
index e6be162..2cbc2e3 100644
--- a/docs/usage.md
+++ b/docs/running-tests.md
@@ -3,8 +3,8 @@
Buttercup is primarily meant to be used non-interactively, to
automatically test a project independent of a user’s setup, before a
commit and on a continuous integration platform. Because of this, the
-workflow for buttercup does not use interactive commands but instead
-the command line.
+recommended workflow for buttercup does not use interactive commands
+but instead the command line.
## Cask
diff --git a/docs/testrunners.md b/docs/testrunners.md
deleted file mode 100644
index 34aae59..0000000
--- a/docs/testrunners.md
+++ /dev/null
@@ -1,15 +0,0 @@
-# Test Runners
-
-Evaluating `describe` forms just stores the suites. You need to use a
-test runner to actually evaluate them. Buttercup comes with three test
-runners by default:
-
-- `buttercup-run-at-point` — Evaluate the topmost `describe` form at
- point and run the suite it creates directly. Useful for interactive
- development. But be careful, this uses your current environment,
- which might not be clean (due to said interactive development).
-- `buttercup-run-discover` — Find files in directories specified on
- the command line, load them, and then run all suites defined
- therein. Useful for being run in batch mode.
-- `buttercup-run-markdown` — Run code in markdown files. Used to
- run this file’s code.
diff --git a/docs/introduction.md b/docs/writing-tests.md
similarity index 100%
rename from docs/introduction.md
rename to docs/writing-tests.md
- [nongnu] elpa/buttercup 329d2f9 051/340: Add autoload markers to test runners., (continued)
- [nongnu] elpa/buttercup 329d2f9 051/340: Add autoload markers to test runners., ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 162b862 060/340: The buttercup--funcall function., ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 638a836 061/340: The batch reporter now displays failures and stack traces., ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup c61a69a 066/340: A rudimentary interactive reporter., ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 182a974 068/340: Pending specs and disabled suites., ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup b3bb12a 070/340: buttercup-run-discover: Fix regexp., ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 26f8117 071/340: Rename buttercup-test.el and move it to the right directory., ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup f593486 092/340: Use pattern _ not t in pcase, as t is deprecated, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 0a889e2 098/340: Merge pull request #43 from spwhitton/apt-get, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup afbaae1 091/340: Document file names for test discovery, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 25cb350 089/340: Rename docs to be more easily understandable,
ELPA Syncer <=
- [nongnu] elpa/buttercup 6d96ea3 093/340: Add format specifier to error call with argument, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup cef9988 110/340: Merge pull request #61 from spwhitton/fix-regexp, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 2b5f53d 121/340: [Fix #72] Add buttercup-minor-mode, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 5db07c9 112/340: Merge pull request #63 from ebpa/patch-1, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup a05fdcb 117/340: Colorize output, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup ed649d7 125/340: Merge pull request #76 from DamienCassou/make-buttercup--with-cleanup-public, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup ce75b50 115/340: Report load errors in buttercup-run-discover, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 3deb9a4 053/340: Test discovery: Ignore files in dot directories., ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 444716b 079/340: Handle windows better in interactive runs., ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 512b82b 077/340: Rework documentation to make the readme more concise., ELPA Syncer, 2021/12/16