From a24298ab76c71fd3152d86997da925ddc03caff4 Mon Sep 17 00:00:00 2001 From: Brett Smith Date: Thu, 24 Oct 2024 10:00:38 -0400 Subject: [PATCH] 22075: Improve formatting of description documentation Mark the tag names as code for better readability. Arvados-DCO-1.1-Signed-off-by: Brett Smith --- sdk/R/arvados-v1-discovery.json | 10 +++++----- sdk/python/arvados-v1-discovery.json | 10 +++++----- .../app/controllers/arvados/v1/schema_controller.rb | 7 ++++++- 3 files changed, 16 insertions(+), 11 deletions(-) diff --git a/sdk/R/arvados-v1-discovery.json b/sdk/R/arvados-v1-discovery.json index 78339e33db..f04690f2b5 100644 --- a/sdk/R/arvados-v1-discovery.json +++ b/sdk/R/arvados-v1-discovery.json @@ -3942,7 +3942,7 @@ "type": "string" }, "description": { - "description": "A longer description of this collection assigned by a user. May contain HTML formatting. Allowed HTML tags are: a, b, blockquote, br, code, del, dd, dl, dt, em, h1, h2, h3, h4, h5, h6, hr, i, img, kbd, li, ol, p, pre, s, del, section, span, strong, sub, sup, and ul.", + "description": "A longer HTML description of this collection assigned by a user.\nAllowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`,\n`del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`,\n`i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`,\n`s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`.", "type": "string" }, "properties": { @@ -4266,7 +4266,7 @@ "type": "string" }, "description": { - "description": "A longer description of this container request assigned by a user. May contain HTML formatting. Allowed HTML tags are: a, b, blockquote, br, code, del, dd, dl, dt, em, h1, h2, h3, h4, h5, h6, hr, i, img, kbd, li, ol, p, pre, s, del, section, span, strong, sub, sup, and ul.", + "description": "A longer HTML description of this container request assigned by a user.\nAllowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`,\n`del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`,\n`i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`,\n`s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`.", "type": "text" }, "properties": { @@ -4433,7 +4433,7 @@ "type": "string" }, "description": { - "description": "A longer description of this group assigned by a user. May contain HTML formatting. Allowed HTML tags are: a, b, blockquote, br, code, del, dd, dl, dt, em, h1, h2, h3, h4, h5, h6, hr, i, img, kbd, li, ol, p, pre, s, del, section, span, strong, sub, sup, and ul.", + "description": "A longer HTML description of this group assigned by a user.\nAllowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`,\n`del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`,\n`i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`,\n`s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`.", "type": "string" }, "group_class": { @@ -4860,7 +4860,7 @@ "type": "string" }, "description": { - "description": "A longer description of this user agreement assigned by a user. May contain HTML formatting. Allowed HTML tags are: a, b, blockquote, br, code, del, dd, dl, dt, em, h1, h2, h3, h4, h5, h6, hr, i, img, kbd, li, ol, p, pre, s, del, section, span, strong, sub, sup, and ul.", + "description": "A longer HTML description of this user agreement assigned by a user.\nAllowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`,\n`del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`,\n`i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`,\n`s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`.", "type": "string" }, "properties": { @@ -5030,7 +5030,7 @@ "type": "string" }, "description": { - "description": "A longer description of this workflow assigned by a user. May contain HTML formatting. Allowed HTML tags are: a, b, blockquote, br, code, del, dd, dl, dt, em, h1, h2, h3, h4, h5, h6, hr, i, img, kbd, li, ol, p, pre, s, del, section, span, strong, sub, sup, and ul.", + "description": "A longer HTML description of this workflow assigned by a user.\nAllowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`,\n`del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`,\n`i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`,\n`s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`.", "type": "text" }, "definition": { diff --git a/sdk/python/arvados-v1-discovery.json b/sdk/python/arvados-v1-discovery.json index 78339e33db..f04690f2b5 100644 --- a/sdk/python/arvados-v1-discovery.json +++ b/sdk/python/arvados-v1-discovery.json @@ -3942,7 +3942,7 @@ "type": "string" }, "description": { - "description": "A longer description of this collection assigned by a user. May contain HTML formatting. Allowed HTML tags are: a, b, blockquote, br, code, del, dd, dl, dt, em, h1, h2, h3, h4, h5, h6, hr, i, img, kbd, li, ol, p, pre, s, del, section, span, strong, sub, sup, and ul.", + "description": "A longer HTML description of this collection assigned by a user.\nAllowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`,\n`del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`,\n`i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`,\n`s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`.", "type": "string" }, "properties": { @@ -4266,7 +4266,7 @@ "type": "string" }, "description": { - "description": "A longer description of this container request assigned by a user. May contain HTML formatting. Allowed HTML tags are: a, b, blockquote, br, code, del, dd, dl, dt, em, h1, h2, h3, h4, h5, h6, hr, i, img, kbd, li, ol, p, pre, s, del, section, span, strong, sub, sup, and ul.", + "description": "A longer HTML description of this container request assigned by a user.\nAllowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`,\n`del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`,\n`i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`,\n`s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`.", "type": "text" }, "properties": { @@ -4433,7 +4433,7 @@ "type": "string" }, "description": { - "description": "A longer description of this group assigned by a user. May contain HTML formatting. Allowed HTML tags are: a, b, blockquote, br, code, del, dd, dl, dt, em, h1, h2, h3, h4, h5, h6, hr, i, img, kbd, li, ol, p, pre, s, del, section, span, strong, sub, sup, and ul.", + "description": "A longer HTML description of this group assigned by a user.\nAllowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`,\n`del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`,\n`i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`,\n`s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`.", "type": "string" }, "group_class": { @@ -4860,7 +4860,7 @@ "type": "string" }, "description": { - "description": "A longer description of this user agreement assigned by a user. May contain HTML formatting. Allowed HTML tags are: a, b, blockquote, br, code, del, dd, dl, dt, em, h1, h2, h3, h4, h5, h6, hr, i, img, kbd, li, ol, p, pre, s, del, section, span, strong, sub, sup, and ul.", + "description": "A longer HTML description of this user agreement assigned by a user.\nAllowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`,\n`del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`,\n`i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`,\n`s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`.", "type": "string" }, "properties": { @@ -5030,7 +5030,7 @@ "type": "string" }, "description": { - "description": "A longer description of this workflow assigned by a user. May contain HTML formatting. Allowed HTML tags are: a, b, blockquote, br, code, del, dd, dl, dt, em, h1, h2, h3, h4, h5, h6, hr, i, img, kbd, li, ol, p, pre, s, del, section, span, strong, sub, sup, and ul.", + "description": "A longer HTML description of this workflow assigned by a user.\nAllowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`,\n`del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`,\n`i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`,\n`s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`.", "type": "text" }, "definition": { diff --git a/services/api/app/controllers/arvados/v1/schema_controller.rb b/services/api/app/controllers/arvados/v1/schema_controller.rb index 9ac78b6b6d..b4ac01113d 100644 --- a/services/api/app/controllers/arvados/v1/schema_controller.rb +++ b/services/api/app/controllers/arvados/v1/schema_controller.rb @@ -128,7 +128,12 @@ to use for this container.", "A string that the defines the working directory that the dispatcher should use when it executes the command inside this container.", "delete_at" => "The time this %s will be permanently deleted.", - "description" => "A longer description of this %s assigned by a user. May contain HTML formatting. Allowed HTML tags are: a, b, blockquote, br, code, del, dd, dl, dt, em, h1, h2, h3, h4, h5, h6, hr, i, img, kbd, li, ol, p, pre, s, del, section, span, strong, sub, sup, and ul.", + "description" => + "A longer HTML description of this %s assigned by a user. +Allowed HTML tags are `a`, `b`, `blockquote`, `br`, `code`, +`del`, `dd`, `dl`, `dt`, `em`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `hr`, +`i`, `img`, `kbd`, `li`, `ol`, `p`, `pre`, +`s`, `section`, `span`, `strong`, `sub`, `sup`, and `ul`.", "environment" => "A hash of string keys and values that defines the environment variables for the dispatcher to set when it executes this container.", -- 2.30.2