docs: add a header to config docs

d-biehl · d-biehl · commit 17ae419c237c · 2024-05-19T00:16:22.000+02:00
diff --git a/docs/cli/config.md b/docs/cli/config.md
@@ -1,3 +1,5 @@
+# robot.toml configuration settings
+
 ## [profile].description
 
 Type: `Optional[str]`
diff --git a/src/robotcode/cli/commands/config.py b/src/robotcode/cli/commands/config.py
@@ -307,7 +307,7 @@ def desc(app: Application, name: Optional[List[str]] = None) -> None:
     ]
 
     if app.config.output_format is None or app.config.output_format == OutputFormat.TEXT:
-        output = ""
+        output = "# robot.toml configuration settings\n\n"
         for field, value in config_fields:
             output += f"## {field}\n\n"
             type = (

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# robot.toml configuration settings`
	`2`	`+`
`1`	`3`	`## [profile].description`
`2`	`4`
`3`	`5`	Type: `Optional[str]`
Original file line number	Diff line number	Diff line change
`@@ -307,7 +307,7 @@ def desc(app: Application, name: Optional[List[str]] = None) -> None:`
`307`	`307`	`]`
`308`	`308`
`309`	`309`	`if app.config.output_format is None or app.config.output_format == OutputFormat.TEXT:`
`310`		`- output = ""`
	`310`	`+ output = "# robot.toml configuration settings\n\n"`
`311`	`311`	`for field, value in config_fields:`
`312`	`312`	`output += f"## {field}\n\n"`
`313`	`313`	`type = (`