feat(tasks): Improve naming

serenity-js · Feb 5, 2017 · f5e8e22 · f5e8e22
1 parent 7790774
commit f5e8e22
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/spec/api/serenity/recording/step_annotation.spec.ts b/spec/api/serenity/recording/step_annotation.spec.ts
@@ -1,6 +1,6 @@
 import { Journal, StageManager } from '../../../../src/serenity/stage';
 
-import { Actor, addDescription, PerformsTasks, step, Task } from '../../../../src/screenplay';
+import { Actor, describeStep, PerformsTasks, step, Task } from '../../../../src/screenplay';
 
 import expect = require('../../../expect');
 import { ActivityFinished, ActivityStarts } from '../../../../src/serenity/domain/events';
@@ -147,7 +147,7 @@ describe('Notifiers', () => {
 
                 const PayWithCreditCard = {
                     number(creditCardNumber: string) {
-                        return addDescription(
+                        return describeStep(
                             actor => actor.attemptsTo( /*...*/ ),
                             `{0} pays with a credit card number ${creditCardNumber}`,
                         );
@@ -189,7 +189,7 @@ describe('Notifiers', () => {
 
                 const PayWithInvalidCreditCardThrowingAnError = {
                     number(creditCardNumber: string) {
-                        return addDescription(
+                        return describeStep(
                             (actor: PerformsTasks) => { throw new Error('Payment failed'); },
                             `{0} pays with an invalid credit card number ${creditCardNumber}`,
                         );
@@ -198,7 +198,7 @@ describe('Notifiers', () => {
 
                 const PayWithInvalidCreditCardThrowingAnAssertionError = {
                     number(creditCardNumber: string) {
-                        return addDescription(
+                        return describeStep(
                             (actor: PerformsTasks) => expect(Promise.resolve(false)).to.eventually.equal(true),
                             `{0} pays with an invalid credit card number ${creditCardNumber}`,
                         );
@@ -232,7 +232,7 @@ describe('Notifiers', () => {
 
                 const PayWithInvalidCreditCardRejectingAPromise = {
                     number(creditCardNumber: string) {
-                        return addDescription(
+                        return describeStep(
                             (actor: PerformsTasks) => Promise.reject(new Error('Payment failed')),
                             `{0} pays with an invalid credit card number ${creditCardNumber}`,
                         );

diff --git a/src/serenity/recording/step_annotation.ts b/src/serenity/recording/step_annotation.ts
@@ -3,14 +3,14 @@ import { Attemptable, Performable } from '../screenplay/performables';
 // todo: add Significance to the @step
 export function step<T extends Performable>(stepDescriptionTemplate: string): StepAnnotation<T> {
     return (target: T, propertyKey: string, descriptor: PerformAsMethodSignature) => {
-        addDescription(target, stepDescriptionTemplate);
+        describeStep(target, stepDescriptionTemplate);
         return descriptor;
     };
 }
 
 export const StepAnnotationSymbol = Symbol('StepAnnotation');
 
-export function addDescription<T extends Attemptable>(target: T, template: string): T {
+export function describeStep<T extends Attemptable>(target: T, template: string): T {
     target[StepAnnotationSymbol] = template;
     return target;
 }