Skip to content

Commit adc5681

Browse files
committed
More description updates
1 parent 7dda91a commit adc5681

File tree

7 files changed

+20
-16
lines changed

7 files changed

+20
-16
lines changed

components/monday/actions/common/common-create-item.mjs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export default {
1111
}),
1212
],
1313
type: "string[]",
14-
description: "Select columns to fill",
14+
description: "Select which item columns to set values for.",
1515
reloadProps: true,
1616
},
1717
},
@@ -23,11 +23,11 @@ export default {
2323
for (const column of this.columns) {
2424
let description;
2525
if (column === "status") {
26-
description = "Value for status. [Status Index Value Map](https://view.monday.com/1073554546-ad9f20a427a16e67ded630108994c11b?r=use1)";
26+
description = "The status of the item. [See more about status values here](https://view.monday.com/1073554546-ad9f20a427a16e67ded630108994c11b?r=use1).";
2727
} else if (column === "person") {
28-
description = "The ID of the person/user to add to item";
28+
description = "The ID of a person/user.";
2929
} else if (column === "date4") {
30-
description = "Enter date of item in YYYY-MM-DD format. Eg. `2022-09-02`";
30+
description = "A date string in `YYYY-MM-DD` format, e.g. `2022-09-02`.";
3131
} else {
3232
description = `Value for column ${column}. See the [Column Type Reference](https://developer.monday.com/api-reference/docs/column-types-reference) to learn more about entering column type values.`;
3333
}

components/monday/actions/create-column/create-column.mjs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,19 @@ export default {
1818
title: {
1919
type: "string",
2020
label: "Title",
21-
description: "The new column's title.",
21+
description: "The title of the new column.",
2222
},
2323
columnType: {
2424
type: "string",
2525
label: "Column Type",
26-
description: "The new column's title",
26+
description: "The type of the new column.",
2727
options: constants.COLUMN_TYPE_OPTIONS,
2828
reloadProps: true,
2929
},
3030
description: {
3131
type: "string",
3232
label: "Description",
33-
description: "The column's description.",
33+
description: "The description of the new column.",
3434
optional: true,
3535
},
3636
},
@@ -39,7 +39,7 @@ export default {
3939
const defaults = {
4040
type: "string",
4141
label: "Defaults",
42-
description: "The new column's defaults. For use with column types `status` or `dropdown`. [See the documentation](https://developer.monday.com/api-reference/reference/columns#create-a-status-or-dropdown-column-with-custom-labels) for additional information.",
42+
description: "The new column's defaults. For use with column types `status` or `dropdown`. [See the documentation](https://developer.monday.com/api-reference/reference/columns#create-a-status-or-dropdown-column-with-custom-labels) for more information.",
4343
optional: true,
4444
};
4545
if (this.columnType === "status") {

components/monday/actions/create-subitem/create-subitem.mjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ export default {
2626
}),
2727
],
2828
optional: false,
29-
description: "The parent item's unique identifier",
29+
description: "Select a parent item or provide an item ID.",
3030
},
3131
itemName: {
3232
propDefinition: [
3333
monday,
3434
"itemName",
3535
],
36-
description: "The new subitem's name",
36+
description: "The new subitem's name.",
3737
},
3838
...commonCreateItem.props,
3939
},

components/monday/actions/create-update/create-update.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export default {
3333
},
3434
parentId: {
3535
label: "Parent Update ID",
36-
description: "The parent post identifier",
36+
description: "Select a parent update or provide an update ID.",
3737
propDefinition: [
3838
monday,
3939
"updateId",

components/monday/actions/get-column-values/get-column-values.mjs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ export default {
44
...common,
55
key: "monday-get-column-values",
66
name: "Get Column Values",
7-
description: "Return values of a specific column or columns for a board item. [See the documentation](https://developer.monday.com/api-reference/docs/column-values-v2)",
7+
description: "Return values of specific column(s) for a board item. [See the documentation](https://developer.monday.com/api-reference/docs/column-values-v2)",
88
version: "0.0.6",
99
type: "action",
1010
props: {
@@ -29,7 +29,7 @@ export default {
2929
],
3030
type: "string[]",
3131
label: "Columns",
32-
description: "Return data from the specified column(s)",
32+
description: "Select the column(s) to return data from.",
3333
optional: true,
3434
},
3535
},
@@ -49,7 +49,7 @@ export default {
4949
throw new Error(response.errors[0].message);
5050
}
5151

52-
$.export("$summary", `Successfully retrieved column values for item with ID ${this.itemId}.`);
52+
$.export("$summary", `Successfully retrieved column values for item with ID ${this.itemId}`);
5353

5454
return this.formatColumnValues(response.data.items);
5555
},

components/monday/actions/get-items-by-column-value/get-items-by-column-value.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export default {
2222
value: {
2323
type: "string",
2424
label: "Value",
25-
description: "The value to serach for. [See documentation](https://developer.monday.com/api-reference/docs/items-by-column-values#supported-limited-support-and-unsupported-columns) for additional information about column values.",
25+
description: "The value to search for. [See the documentation](https://developer.monday.com/api-reference/docs/items-by-column-values#supported-limited-support-and-unsupported-columns) for additional information about column values.",
2626
},
2727
},
2828
async run({ $ }) {

components/monday/actions/update-column-values/update-column-values.mjs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,13 @@ export default {
1212
type: "action",
1313
props: {
1414
...common.props,
15+
updateInfoBox: {
16+
type: "alert",
17+
alertType: "info",
18+
content: "See the [Column types reference](https://developer.monday.com/api-reference/docs/column-types-reference) to find the proper data structures for supported column types.",
19+
},
1520
boardId: {
1621
...common.props.boardId,
17-
description: "The board's unique identifier. See the [Column types reference](https://developer.monday.com/api-reference/docs/column-types-reference) to find the proper data structures for supported column types.",
1822
reloadProps: true,
1923
},
2024
itemId: {

0 commit comments

Comments
 (0)