1
0
mirror of https://github.com/MontFerret/ferret.git synced 2025-07-15 01:25:00 +02:00

Feature/doc markup (#543)

* Added release notes

* #509 fixedOCOD typo

* Updated values

* Updated comments

* Changed stdlib docs format

* Changed format of array in docs

* Use 'any' instead of 'value' in docs

* New format for optional params

* Updated docs for testing package

* Added namespace information
This commit is contained in:
Tim Voronov
2020-08-07 21:49:29 -04:00
committed by GitHub
parent 6c5aca52ab
commit 24d8eedd4c
216 changed files with 863 additions and 801 deletions

View File

@ -10,10 +10,10 @@ import (
"github.com/MontFerret/ferret/pkg/stdlib/testing/base"
)
// Include asserts that haystack includes needle.
// @params actual (String|Array|Object|Iterable) - Haystack value.
// @params expected (Mixed) - Expected value.
// @params message (String, optional) - Message to display on error.
// INCLUDE asserts that haystack includes needle.
// @param {String | Array | Object | Iterable} actual - Haystack value.
// @param {Any} expected - Expected value.
// @param {String} [message] - Message to display on error.
var Include = base.Assertion{
DefaultMessage: func(args []core.Value) string {
return fmt.Sprintf("include %s", base.FormatValue(args[1]))