Skip to content

Commit 1299b85

Browse files
committed
Update README.md and LICENSE.md
1 parent 434d0c2 commit 1299b85

File tree

2 files changed

+22
-27
lines changed

2 files changed

+22
-27
lines changed

LICENSE.md

Lines changed: 17 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,21 @@
1-
Copyright (c) 2014, Katherine Whitlock
2-
All rights reserved.
1+
The MIT License (MIT)
32

4-
Redistribution and use in source and binary forms, with or without
5-
modification, are permitted provided that the following conditions are met:
3+
Copyright (c) 2016 Katherine Whitlock
64

7-
* Redistributions of source code must retain the above copyright notice, this
8-
list of conditions and the following disclaimer.
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
911

10-
* Redistributions in binary form must reproduce the above copyright notice,
11-
this list of conditions and the following disclaimer in the documentation
12-
and/or other materials provided with the distribution.
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
1314

14-
* Neither the name of the project nor the names of its
15-
contributors may be used to endorse or promote products derived from
16-
this software without specific prior written permission.
17-
18-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19-
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20-
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21-
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
22-
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23-
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24-
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
25-
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26-
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27-
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,10 @@ describe fabs_spec("fabs", $ {
3535
});
3636
});
3737

38+
// describe_a allows you to create specs with implied subjects,
39+
// useful for testing specific classes and a mock instance
3840
describe_a <std::list<int>> int_list_spec({1,2,3}, $ {
41+
// the `is_expected` function is used for matching an implied subject
3942
it(_{ is_expected().to_include(3); });
4043
});
4144

@@ -99,11 +102,9 @@ to be cleaned up.
99102
Why, thank you! I certainly tried.
100103

101104
## What the heck are `$` and `_`!?
102-
TLDR: They're syntax sugar for `[](auto &self)` and `[=](auto &self)` respectively.
105+
They're just syntax sugar for `[](auto &self)` and `[=](auto &self)` respectively, defined to avoid repetition and improve readability. `it([=](auto &self){ is_expected.to_equal(5); });` isn't exactly what I'm aiming for with syntax.
103106

104-
They're defined to avoid repetition and improve readability. (`it([=](auto &self){ is_expected.to_equal(5); });` isn't exactly what I was aiming for with syntax)
105-
106-
We need them to pass a reference to the containing "thing". For example, `describe`
107+
We need that `self` parameter to pass a reference to the containing structure. For example, `describe`
107108
blocks get a `Description` object, while `it` blocks get an `It` object.
108109

109110
Annoyingly, you can't have an automatic capture-list on a non-local lambda

0 commit comments

Comments
 (0)