verifyFunctionReturnTypesDefinition: Verify Function Return Types Definition

In wyz.code.offensiveProgramming: Wizardry Code Offensive Programming

Verify Function Return Types Definition

Description

Verifies your declared return type definitions and detects anomalies.

Usage

verifyFunctionReturnTypesDefinition(object_o_1,
                                    requiresFullInstrumentation_b_1 = TRUE)

Arguments

object_o_1	The object to be considered
requiresFullInstrumentation_b_1	a boolean stating if full instrumentation is required

Details

When requiresFullInstrumentation_b_1 is TRUE, each function must have an entry in the test case parameter definition.

Value

A list with names

validity	a single boolean value
class	the class name of the provided object.
intent	the stage of the failure, provides hint about the faced issue
message	some hints to resolve the issue(s).

Author(s)

Fabien Gelineau <[e-mail]>

Maintainer: Fabien Gelineau <[e-mail]>

See Also

Refer to defineTestCaseDefinitionsParameterName.

Examples

##---- typical case ----
library('data.table')
source(system.file('code-samples/frt-defs/good/full/AdditionFI.R',
                   package = 'wyz.code.offensiveProgramming'))
fi <- AdditionFI()
print(verifyFunctionReturnTypesDefinition(fi))
print(verifyFunctionReturnTypesDefinition(fi, FALSE))

wyz.code.offensiveProgramming documentation built on Sept. 25, 2023, 9:05 a.m.