_@Description

Owned by Michael Bruton (Deactivated)
Last updated: May 27, 2015
1 min read

Description

  • Provide in-line documentation in the ETLUnit test class.
  • This is useful to include documentation that will stay with the test class, since it is part of its code.

Attributes

Attribute

Name

Required?

Possible

Values

Info
descriptionYes
  • A single-quote-delimited string, or a list of such.
  • Intended to provide helpful documentation that will stay with the test class.

Location in the test class file

  • Can appear almost anywhere outside a method.
  • Cannot be placed at the end of a class.
  • Cannot be placed at the end of the ETLUnit source file (outside any class).
  • Typical locations are before the class declaration and before a method declaration.

Examples

 

@Description

@Description(

description: 'ETL process loads all data from source to target with mapping rules'

)

@Description(

description: [

'This is a multiline',

'description.'

]

)

Â