# Style guide

# YAML
# YAML cheat sheet http://www.yaml.org/refcard.html
# Easy to read YAML cookbook http://www.yaml.org/YAML_for_ruby.html
# Official YAML site http://www.yaml.org/

# Set right margin to 80 columns
# Tabs are not allowed in YAML!
# Use 2 spaces for indentation.

# Be careful using indicators in strings. In particular, the comma, colon,
# and pound sign must be used carefully.


# How to specify node structures, because they are more of
# hash table (dictionary or map)
---

is_array_like: true     # Requires array like structure

# Info properties
info-properties:        # Example values
  name:                 show_before_you_start_info.profiles

  label:

  removed:              true # The option no longer works, is not functional.
  version_removed:

  deprecated:           true # Something which is deprecated may still work, it is functional.
                        # Features are deprecated—rather than immediately removed—in order
                        # to provide backward compatibility, and give programmers who have used
                        # the feature time to bring their code into compliance with the new standard.
  version_deprecated:

  value:                # Description of the value
  values:               # An array of values
  default_value:        true
  min_value:            9
  max_value:            2100

  required_if:          # Required or optionally required comments, description
                        # or condition.
                        # If omitted we assume it is always required

  shortcut:             # Command line option shortcut

  comment:              # Comments intended for developers only
  short_description:    # Short description, intended for users
  description:          # Main description, intended for users

  change_log:           # Sequence which starts with a date in ISO8601 order.
                        - 2014-02-10 -- Added

                        - 2014-02-15 -- Some changes ...
                          with a comment over multiple lines

                        - 2014-03-10 -- Removed, option is no longer required.

                        - 2014-03-17 -- Re-added

  version_added:        8.7.3

...