From 07f7e285ec5b49915fd2297e415db7d822cb9e3b Mon Sep 17 00:00:00 2001 From: Faizaan Gagan Date: Wed, 2 Jun 2021 11:21:45 +0530 Subject: [PATCH] modified docs --- lib/custom_wizard/field.rb | 13 +++++++------ lib/custom_wizard/template.rb | 7 ------- 2 files changed, 7 insertions(+), 13 deletions(-) diff --git a/lib/custom_wizard/field.rb b/lib/custom_wizard/field.rb index 951419b6..aacb163b 100644 --- a/lib/custom_wizard/field.rb +++ b/lib/custom_wizard/field.rb @@ -8,14 +8,15 @@ class CustomWizard::Field # number: 3 # title: Add the field name to attribute map # description: The attribute map serves as a global registry for field attributes. Set the - # key as the attribute name and value as an array of properties. Use the properties according to the + # key as the attribute name and value as an array of properties. Use the properties according to # your usecase. Here's a list and description of each of the properties. - # accessible: The attribute is passed to attr_accessor + # ``` + # accessible: The attribute is set as a CustomWizard::Field attr_accessor # serializable: The attribute is serialized to the client - # permitted: The attribute is permitted to be passed to the admin side controller for saving - # mapped: The attribute is a mapped attributed and is permitted to be passed to the admin side controller for saving - # excluded: The attribute is not initialized in the constructor. This is used - # if the attribute needs a method + # permitted: The attribute is permitted in the admin controller + # mapped: The attribute is mapped and permitted (see above) + # excluded: The attribute is not initialized in the constructor + # ``` ## def self.attribute_map diff --git a/lib/custom_wizard/template.rb b/lib/custom_wizard/template.rb index a11bd4a0..a1c0aad0 100644 --- a/lib/custom_wizard/template.rb +++ b/lib/custom_wizard/template.rb @@ -14,13 +14,6 @@ class CustomWizard::Template @actions = data['actions'] || [] end - ## - # type: step - # number: 4 - # title: Our new field is saved to the template - # description: The template is loaded into the wizard model when it is built, - # our attribute has to be present, for it to build properly... - ## def save(opts = {}) @opts = opts