aboutsummaryrefslogtreecommitdiff
path: root/docs/yaml/functions/configuration_data.yaml
blob: e16a69fc1b12f32630f141af636d1ec0d9b2cf2e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
name: configuration_data
returns: cfg_data
description: |
  Creates an empty configuration object. You should add your
  configuration with the [[@cfg_data]] method calls and
  finally use it in a call to [[configure_file]].

optargs:
  data:
    type: dict[str | bool | int]
    since: 0.49.0
    description: |
      Optional dictionary to specifiy an inital data set. If
      provided, each key/value pair is added into the [[@cfg_data]] object
      as if the [[cfg_data.set]] method was called for each of them.