From 46907e473007b0ac74b3f235b3595b065d73a923 Mon Sep 17 00:00:00 2001 From: Jeremy Stanley Date: Sat, 16 Sep 2017 17:43:08 +0000 Subject: [PATCH] Add descriptions to sample datafiles For improved clarity, add some basic descriptions to the provided sample datafiles in "_desc" metadata keys. --- etc/mudpy.yaml | 1 + mudpy/tests/fixtures/test_daemon.yaml | 2 ++ sample/__init__.yaml | 2 ++ sample/area.yaml | 3 +++ sample/prop.yaml | 2 ++ share/archetype.yaml | 2 ++ share/command.yaml | 2 ++ share/menu.yaml | 2 ++ 8 files changed, 16 insertions(+) diff --git a/etc/mudpy.yaml b/etc/mudpy.yaml index 4570691..ed43c59 100644 --- a/etc/mudpy.yaml +++ b/etc/mudpy.yaml @@ -2,6 +2,7 @@ _copy: Copyright (c) 2004-2017 Jeremy Stanley . Permission to use, copy, modify, and distribute this software is granted under terms provided in the LICENSE file distributed with this software. +_desc: This is the top-level configuration file for mudpy service. _load: [ archetype.yaml, command.yaml, menu.yaml, sample ] diff --git a/mudpy/tests/fixtures/test_daemon.yaml b/mudpy/tests/fixtures/test_daemon.yaml index 0f7e980..7c39b1d 100644 --- a/mudpy/tests/fixtures/test_daemon.yaml +++ b/mudpy/tests/fixtures/test_daemon.yaml @@ -2,6 +2,8 @@ _copy: Copyright (c) 2004-2017 Jeremy Stanley . Permission to use, copy, modify, and distribute this software is granted under terms provided in the LICENSE file distributed with this software. +_desc: This is an alternative top-level configuration with some values adjusted + to better suit automated testing scenarios. _load: [ archetype.yaml, command.yaml, menu.yaml, sample ] diff --git a/sample/__init__.yaml b/sample/__init__.yaml index 159648d..4d4c945 100644 --- a/sample/__init__.yaml +++ b/sample/__init__.yaml @@ -2,6 +2,8 @@ _copy: Copyright (c) 2004-2017 Jeremy Stanley . Permission to use, copy, modify, and distribute this software is granted under terms provided in the LICENSE file distributed with this software. +_desc: This is an index file for a sample collection of elements. + _load: [ area.yaml, prop.yaml ] _lock: true diff --git a/sample/area.yaml b/sample/area.yaml index 0213573..8eb13c5 100644 --- a/sample/area.yaml +++ b/sample/area.yaml @@ -2,6 +2,9 @@ _copy: Copyright (c) 2004-2017 Jeremy Stanley . Permission to use, copy, modify, and distribute this software is granted under terms provided in the LICENSE file distributed with this software. +_desc: This is a set of sample locations for testing and demonstration + purposes. + area:-1,0,0: description: This is the West Sample Location. It is merely provided as an example of what an area might look like. gridlinks: ['east'] diff --git a/sample/prop.yaml b/sample/prop.yaml index 259d75f..73b6e53 100644 --- a/sample/prop.yaml +++ b/sample/prop.yaml @@ -2,6 +2,8 @@ _copy: Copyright (c) 2004-2017 Jeremy Stanley . Permission to use, copy, modify, and distribute this software is granted under terms provided in the LICENSE file distributed with this software. +_desc: This is a set of sample objects for testing and demonstration purposes. + prop:sample_prop: impression: A sample prop sits here. keywords: sample prop diff --git a/share/archetype.yaml b/share/archetype.yaml index 88f612e..9d31cbd 100644 --- a/share/archetype.yaml +++ b/share/archetype.yaml @@ -2,6 +2,8 @@ _copy: Copyright (c) 2004-2017 Jeremy Stanley . Permission to use, copy, modify, and distribute this software is granted under terms provided in the LICENSE file distributed with this software. +_desc: These are the base archetypes from which other elements inherit. + _lock: true archetype:actor: diff --git a/share/command.yaml b/share/command.yaml index 51c7c79..84580de 100644 --- a/share/command.yaml +++ b/share/command.yaml @@ -2,6 +2,8 @@ _copy: Copyright (c) 2004-2017 Jeremy Stanley . Permission to use, copy, modify, and distribute this software is granted under terms provided in the LICENSE file distributed with this software. +_desc: This is the standard library of command definitions. + _lock: true command:chat: diff --git a/share/menu.yaml b/share/menu.yaml index a58baf1..347f8d0 100644 --- a/share/menu.yaml +++ b/share/menu.yaml @@ -2,6 +2,8 @@ _copy: Copyright (c) 2004-2017 Jeremy Stanley . Permission to use, copy, modify, and distribute this software is granted under terms provided in the LICENSE file distributed with this software. +_desc: This is the standard library of menu definitions. + _lock: true menu:activate_avatar: -- 2.11.0