From 58258bee0a2d0caae37a7397d5c08aee0902dfd9 Mon Sep 17 00:00:00 2001 From: Fred Condo Date: Fri, 20 Jan 2012 09:33:45 -0800 Subject: [PATCH 1/4] MINOR: Added newline at EOF --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c8ef724..5e34db3 100644 --- a/README.md +++ b/README.md @@ -81,4 +81,4 @@ If you wish to embed an environment check suite in another, you can use the foll * `$result->Status()`: The string "OK", "WARNING", or "ERROR", depending on the worst failure. * `$result->Details()`: A `DataObjectSet` of details about the result of each check in the suite. -See `EnvironmentChecker.ss` to see how these can be used to build a UI. \ No newline at end of file +See `EnvironmentChecker.ss` to see how these can be used to build a UI. From 0ea3e23e3893186096b508dd39441f2a0f64e2d0 Mon Sep 17 00:00:00 2001 From: Fred Condo Date: Fri, 20 Jan 2012 09:24:11 -0800 Subject: [PATCH 2/4] DOC: Typo fix: mode -> module --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5e34db3..b79de12 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Almost, but not really. Environment checks differ from unit tests in two importa ## Adding more checks -To add more checks, you should put additional `EnvironmentCheckSuite::register` calls into your `_config.php`. See the `_config.php` file of this mode for examples. +To add more checks, you should put additional `EnvironmentCheckSuite::register` calls into your `_config.php`. See the `_config.php` file of this module for examples. :::php EnvironmentCheckSuite::register('check', 'HasFunctionCheck("curl_init")', "Does PHP have CURL support?"); From ab96697cd3095781db137dcde3223a64e468e22e Mon Sep 17 00:00:00 2001 From: Fred Condo Date: Fri, 20 Jan 2012 09:25:02 -0800 Subject: [PATCH 3/4] DOC: Remove redundant word --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b79de12..14a7877 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ This module adds an API for running environment checks to your API. Almost, but not really. Environment checks differ from unit tests in two important ways: * **They test environment specific settings.** Unit tests are designed to use dummy data and mock interfaces to external system. Environment checks check the real systems and data that the given environment is actually connected to. - * **They can't modify data.** Because these checks will run using production databases, they can't go modifying the data in there. This is the biggest reason why we haven't used the same base class as a unit test for writing environment checks - we wanted to make it impossible to accidentally plug the a unit test into the environment checker! + * **They can't modify data.** Because these checks will run using production databases, they can't go modifying the data in there. This is the biggest reason why we haven't used the same base class as a unit test for writing environment checks - we wanted to make it impossible to accidentally plug a unit test into the environment checker! ## Adding more checks From a7d01e7637c8936e73ab161bda434e4b758e9cde Mon Sep 17 00:00:00 2001 From: Fred Condo Date: Fri, 20 Jan 2012 09:31:09 -0800 Subject: [PATCH 4/4] DOC: Remove incomplete sentence --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 14a7877..99c9018 100644 --- a/README.md +++ b/README.md @@ -60,8 +60,6 @@ Once you have created your custom check class, don't forget to register it in a ### Using other environment check suites -"health" and "check" are the only environment check suites that we use because they aren - If you want to use the same UI as dev/health and dev/check, you can create an `EnvironmentChecker` object. This class is a `RequestHandler` and so can be returned from an action handler. The first argument to the `EnvironmentChecker` constructor is the suite name. For example: class DevHealth extends Controller {