Skip to content

Commit 7477fa5

Browse files
committed
config: config: Consistent Markdown/Go wording for 'annotations'
I've replaced the old OPTIONAL with our usual: (<type>, <optional|required>) to get the property name first, since that translates more directly into a Go comment that godoc will like. The new Go comment is much shorter, dropping "unstructured" (because the Markdown says "structured or unstructured") and "set by external tools..." (because *everything* in the configuration JSON is set by external-to-the-runtime tools). Signed-off-by: W. Trevor King <[email protected]>
1 parent 9837b6b commit 7477fa5

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -322,7 +322,7 @@ The semantics are the same as `Path`, `Args` and `Env` in [golang Cmd](https://g
322322

323323
## Annotations
324324

325-
This OPTIONAL property contains arbitrary metadata for the container.
325+
**`annotations`** (object, optional) contains arbitrary metadata for the container.
326326
This information MAY be structured or unstructured.
327327
Annotations are key-value maps.
328328

specs-go/config.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ type Spec struct {
1818
Mounts []Mount `json:"mounts,omitempty"`
1919
// Hooks configures callbacks for container lifecycle events.
2020
Hooks Hooks `json:"hooks"`
21-
// Annotations is an unstructured key value map that may be set by external tools to store and retrieve arbitrary metadata.
21+
// Annotations contains arbitrary metadata for the container.
2222
Annotations map[string]string `json:"annotations,omitempty"`
2323

2424
// Linux is platform specific configuration for Linux based containers.

0 commit comments

Comments
 (0)