Merge pull request #42 from php-enspired/signaling

Signaling

Author: adrian-enspired

composer.json

@@ -3,7 +3,7 @@
   "description": "Augmented features for exceptions and exception handling.",
   "type": "library",
   "homepage": "https://php.enspi.red",
-  "license": "GPL-3.0-only",
+  "license": "MPL-2.0",
   "authors": [
     {
       "name": "Adrian",

docs/API:-The-Exceptable-Interface.md

@@ -7,7 +7,7 @@ properties
 ----------
 
 ---
-### readonly array `Exceptable::context`
+### readonly array `$context`
 
 User-provided contextual information for this exception.
 
@@ -26,25 +26,25 @@ For each of these, the following are also available for message formatting:
 - ? Fault `__{exception}Fault__`:   the fault that the exception/previous/root was built from, if any.
 
 ---
-### readonly Fault `Exceptable::fault`
+### readonly Fault `$fault`
 
 The Fault instance that this Exceptable was build from.
 
 ---
-### readonly ? Throwable `Exceptable::previous`
+### readonly ? Throwable `$previous`
 
 The previous exception, if any.
 
 ---
-### readonly Throwable `Exceptable::root`
+### readonly Throwable `$root`
 
 The original (most-previous) exception in this exception's chain. This may be the same as the top-level or previous exception.
 
 methods
 -------
 
 ---
-### `Exceptable::__construct(Fault $fault [, array $context] [, Throwable $previous])`
+### `__construct(Fault $fault [, array $context] [, Throwable $previous])`
 
 Constructs a new Exceptable instance from a Fault.
 
@@ -54,7 +54,7 @@ Constructs a new Exceptable instance from a Fault.
 - Throwable           `$previous` The previous exception, if any.
 
 ---
-### bool `Exceptable::has(Fault $fault)`
+### bool `has(Fault $fault)`
 
 Checks whether this Exceptable contains the given Fault, anywhere in its exception chain.
 
@@ -65,7 +65,7 @@ Checks whether this Exceptable contains the given Fault, anywhere in its excepti
 - boolean
 
 ---
-### bool `Exceptable::is(Fault $fault)`
+### bool `is(Fault $fault)`
 
 Checks whether this Exceptable was built from the given Fault.
 
@@ -78,6 +78,7 @@ Checks whether this Exceptable was built from the given Fault.
 inherited methods
 -----------------
 
+---
 Inherited from [Throwable](https://php.net/throwable):
 - string      `getMessage()`
 - int         `getCode()`

docs/API:-The-ExceptableFault-Class.md

@@ -49,6 +49,7 @@ An error occured but its details are not available.
 exceptables
 -----------
 
+---
 - `LogicException`: thrown for `UnknwonFault`, `UnacceptableFault`
 - `RuntimeException`: thrown for `UncaughtException`
 - `InvalidArgumentException`: thrown for `UnacceptableLogMessage`, `UnknownError`

docs/API:-The-Fault-Interface.md

@@ -57,5 +57,6 @@ Builds an Exceptable from this Fault, using the provided contextual information
 inherited methods
 -----------------
 
+---
 Inherited from [`JsonSerializable`](https://php.net/JsonSerializable):
 - mixed `jsonSerialize()`

docs/API:-The-SplFault-Class.md

@@ -75,6 +75,7 @@ A value does not match with a set of values.
 exceptables
 -----------
 
+---
 Corresponding Exceptable classes are provided for each SplFault case. Each also extends from the core SPL exception class of the same name, sharing semantic meaning and allowing interoperability with code that is unaware of the exceptable types.
 
 - `at\exceptable\Spl\BadFunctionCallException` extends `BadFunctionCallException`

docs/Usage:-Faults-and-Exceptables.md

@@ -24,9 +24,14 @@ enum ProcessFault implements Fault {
 
 Seriously? Yes, seriously, that's it. If you want to skip to the end now you can. Go ahead and start writing your application code, returning and/or throwing these faults.
 
+### error messages
+
 You can build messages for your faults using the intl extension and ICU resource bundles. If you don't, then the error message will just be the name of the fault.
 
 ```php
+<?php
+use at\peekaboo\MessageRegistry;
+
 $context = [
   "type" => "Example",
   "status" => "preparing"
@@ -60,13 +65,13 @@ echo ProcessFault::NotReady->message($context);
 // prints:
 //  ProcessFault.NotReady: Example is not ready (status is 'preparing')
 ```
-_Note, using `EnumeratesFaults` means the fault will_ never _try to look up messages on your registered message bundles. The `makeMessage()` method is still available, and_ will _look up messages if they are registered, but is not used internally._
+> Note, using `EnumeratesFaults` means the fault will _never_ try to look up messages on your registered message bundles. The `makeMessage()` method is still available, and _will_ look up messages if they are registered, but is not used internally.
 
 ### customized behavior
 
 Sensible default behavior is provided by `IsFault` and `EnumeratesFaults`, but there are some aspects that can be customized.
 
-During development, it is _highly_ recommended that you enable assertion checking. The exceptable library uses assertions to sanity-check your modifications - for example, that `exceptableType()` returns a suitable classname. In production, assertions can be safely disabled (and generally, should).
+> Note, During development, it is _highly_ recommended that you enable assertion checking. The exceptable library uses assertions to sanity-check your modifications - for example, that `exceptableType()` returns a suitable classname. In production, assertions can be safely disabled (and generally, should).
 
 #### changing what `Exceptable` type is thrown
 

docs/_Sidebar.md

@@ -1,21 +1,13 @@
 # Contents
 
-### 3.0 is Coming Soon!
-
-- [New in 3.0](https://github.com/php-enspired/exceptable/wiki/New-in-3.0)
-
 ### Usage
-
-- [Exceptables](https://github.com/php-enspired/exceptable/wiki/Usage:-Exceptables)
-- [Spl Exceptables](https://github.com/php-enspired/exceptable/wiki/Usage:-SPL-Exception-Classes)
-- [Handlers](https://github.com/php-enspired/exceptable/wiki/API:-The-Handler-Class)
-- [Making and Testing Exceptables for Your Own Project (coming soon!)](#)
+- [Faults and Exceptables](https://github.com/php-enspired/exceptable/wiki/Usage:-Faults-and-Exceptables)
+- [Spl Faults and Exceptables](https://github.com/php-enspired/exceptable/wiki/Usage:-Spl-Faults-and-Exceptables)
+- [Handlers](https://github.com/php-enspired/exceptable/wiki/Usage:-Handlers)
 
 ### Api
-
+- [The `Fault` Interface](https://github.com/php-enspired/exceptable/wiki/API:-The-Fault-Interface)
 - [The `Exceptable` Interface](https://github.com/php-enspired/exceptable/wiki/API:-The-Exceptable-Interface)
-- [The `Handler` Class](https://github.com/php-enspired/exceptable/wiki/Usage:-Handlers)
-
-### More
-
-- [Docs and the Wiki](https://github.com/php-enspired/exceptable/wiki/Docs-and-Wiki)
+- [The `SplFault` Class](https://github.com/php-enspired/exceptable/wiki/API:-The-SplFault-Class)
+- [The `ExceptableFault` Class](https://github.com/php-enspired/exceptable/wiki/API:-The-ExceptableFault-Class)
+- [The `Handler` Class](https://github.com/php-enspired/exceptable/wiki/API:-The-Handler-Class)