Skip to content
This repository was archived by the owner on Jan 25, 2022. It is now read-only.

Commit 4aae838

Browse files
committed
Added some examples to PHPDoc
1 parent 4f92c9c commit 4aae838

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

cli/tests/includes/assertions

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
#!/usr/bin/env bash
22
#
3-
# Tests if an express outputs a value that is equal.
4-
#
53
# @TODO We need to write a lot more of these
64
#
75

6+
#
7+
# eval<Criteria>() function expect an expression to eval() and then test/compare
8+
# test<Criteria>() function expect a value to test/compare.
9+
#
10+
811
#
912
# Tests if the output of an expression is equal to the supplied value
1013
#
14+
# @example evalEquals "echo hello", "hello"
15+
#
1116
function evalEquals() {
1217
local expr="$1"
1318
local value="$2"
@@ -22,6 +27,9 @@ function evalEquals() {
2227
#
2328
# Tests if two values are equal.
2429
#
30+
# @example: testEquals "$(echo hello)", "hello"
31+
# @example: foo=xyz && testEquals "$foo", "xyz"
32+
#
2533
function testEquals() {
2634
local value1="$1"
2735
local value2="$2"

0 commit comments

Comments
 (0)