nixos/buildkite-agent: enhance documentation for meta-data option

I assumed they were space-separated, which was wrong.

In future it might be better to allow specifying an attrset of strings
for the option.

1 files changed, 3 insertions, 1 deletions

diff --git a/nixos/modules/services/continuous-integration/buildkite-agent.nix b/nixos/modules/services/continuous-integration/buildkite-agent.nix
index ca405546ec0d..cc195d575c3f 100644
--- a/nixos/modules/services/continuous-integration/buildkite-agent.nix
+++ b/nixos/modules/services/continuous-integration/buildkite-agent.nix
@@ -76,8 +76,10 @@ in
       meta-data = mkOption {
         type = types.str;
         default = "";
+        example = "queue=default,docker=true,ruby2=true";
         description = ''
-          Meta data for the agent.
+          Meta data for the agent. This is a comma-separated list of
+          <code>key=value</code> pairs.
         '';
       };