From 48162bc904c3ea7305aac7b8fd55a8fedc0c9cea Mon Sep 17 00:00:00 2001 From: trgiangdo Date: Tue, 23 Jan 2024 19:29:26 +0700 Subject: [PATCH 1/2] fix: wrong link to download my_config.py file --- docs/manuals/core/entities/data-node-mgt.md | 22 ++++++++----------- .../orchestrating-and-job-execution.md | 2 +- .../core/entities/scenario-creation.md | 4 ++-- .../core/entities/scenario-cycle-mgt.md | 2 +- docs/manuals/core/entities/sequence-mgt.md | 2 +- docs/manuals/core/entities/task-mgt.md | 2 +- 6 files changed, 15 insertions(+), 19 deletions(-) diff --git a/docs/manuals/core/entities/data-node-mgt.md b/docs/manuals/core/entities/data-node-mgt.md index cde5a3289..0be187eb8 100644 --- a/docs/manuals/core/entities/data-node-mgt.md +++ b/docs/manuals/core/entities/data-node-mgt.md @@ -1,7 +1,7 @@ Data nodes get created when scenarios are created. Please refer to the [Entities' creation](scenario-creation.md) section for more details. -In this section, it is assumed that `my_config.py` +In this section, it is assumed that `my_config.py` module contains a Taipy configuration already implemented. # Data node attributes @@ -385,8 +385,8 @@ To write with custom column names, use the `CSVDataNode.write_with_column_names( When reading from an Excel data node, Taipy returns the data of the Excel file based on the _exposed_type_ parameter. Check out [Excel Data Node configuration](../config/data-node-config.md#excel) for more details on _exposed_type_. -For the example in this section, assume that `sales_history_cfg` in [`my_config.py`](https://github.com/Avaiga/taipy-doc/blob/develop/docs/manuals/core/my_config.py) -is an _Excel_ data node configuration with `default_path="path/sales.xlsx"`. +For the example in this section, assume that `sales_history_cfg` is an _Excel_ data node +configuration with `default_path="path/sales.xlsx"`. Assume that the content of the `sales.xlsx` file is the following. @@ -542,8 +542,7 @@ To write with custom column names, use the `ExcelDataNode.write_with_column_name When reading from a SQL Table data node, Taipy returns the data of the SQL Table file based on the _exposed_type_ parameter. Check out [SQL Table Data Node configuration](../config/data-node-config.md#sql-table) for more details on _exposed_type_. -For the example in this section, assume that `sales_history_cfg` in [`my_config.py`](https://github.com/Avaiga/taipy-doc/blob/develop/docs/manuals/core/my_config.py) -is a _SQL Table_ data node configuration with `table_name="sales"`. +For the example in this section, assume that `sales_history_cfg` is a _SQL Table_ data node configuration with `table_name="sales"`. Assume that the content of the `"sales"` table is the following. @@ -689,8 +688,7 @@ node: A SQL data node is designed to give the user more flexibility on how to read and write to SQL table (or multiple SQL tables). -Let's consider the `orders_cfg` in -[`my_config.py`](https://github.com/Avaiga/taipy-doc/blob/develop/docs/manuals/core/my_config.py) +Let's consider the `orders_cfg` in `my_config.py` which configures a SQL data node. When reading from a SQL data node, Taipy executes the read query and returns the data of the SQL @@ -803,9 +801,8 @@ also encode and decode: - A [`datetime.datetime`](https://docs.python.org/3/library/datetime.html#datetime-objects) object. - A [dataclass](https://docs.python.org/3/library/dataclasses.html) object. -For the example in this section, assume that `sales_history_cfg` in -[`my_config.py`](https://github.com/Avaiga/taipy-doc/blob/develop/docs/manuals/core/my_config.py) -is a _JSON_ data node configuration with `default_path="path/sales.json"`. +For the example in this section, assume that `sales_history_cfg` is a _JSON_ data node configuration +with `default_path="path/sales.json"`. !!! example "Read and write from a JSON data node using default _encoder_ and _decoder_" @@ -1095,9 +1092,8 @@ MongoDB, including but not limited to: - Object (embedded document object). - Arrays − arrays or list or multiple values. -For the example in this section, assume that `sales_history_cfg` in -[`my_config.py`](https://github.com/Avaiga/taipy-doc/blob/develop/docs/manuals/core/my_config.py) -is a _Mongo collection_ data node configuration. +For the example in this section, assume that `sales_history_cfg` is a _Mongo collection_ data node +configuration. Check out [MongoDB supported data types](https://www.mongodb.com/docs/manual/reference/bson-types/) for more details. diff --git a/docs/manuals/core/entities/orchestrating-and-job-execution.md b/docs/manuals/core/entities/orchestrating-and-job-execution.md index e7dda9727..54a82b7d1 100644 --- a/docs/manuals/core/entities/orchestrating-and-job-execution.md +++ b/docs/manuals/core/entities/orchestrating-and-job-execution.md @@ -8,7 +8,7 @@ can run different Taipy services, please refer to the After running the Core service, all configuration are blocked from update. -In this section, it is assumed that `my_config.py` +In this section, it is assumed that `my_config.py` module contains a Taipy configuration already implemented. To execute a scenario, you need to call the `taipy.submit()^` function. It returns a `Submission^` object containing diff --git a/docs/manuals/core/entities/scenario-creation.md b/docs/manuals/core/entities/scenario-creation.md index 9cceea0d3..6be140c86 100644 --- a/docs/manuals/core/entities/scenario-creation.md +++ b/docs/manuals/core/entities/scenario-creation.md @@ -1,4 +1,4 @@ -In this section, it is assumed that `my_config.py` +In this section, it is assumed that `my_config.py` module contains a Taipy configuration already implemented. # Scenario creation @@ -39,7 +39,7 @@ Three parameters can be given to the scenario creation method : !!! example === "Scenario creation with parameters" - Using the [`my_config.py`](./code_example/my_config.py) module, here is an example of how to create a scenario. + Using the `my_config.py` module, here is an example of how to create a scenario. ```python linenums="1" import taipy as tp diff --git a/docs/manuals/core/entities/scenario-cycle-mgt.md b/docs/manuals/core/entities/scenario-cycle-mgt.md index ce738ec3a..007f8135e 100644 --- a/docs/manuals/core/entities/scenario-cycle-mgt.md +++ b/docs/manuals/core/entities/scenario-cycle-mgt.md @@ -1,7 +1,7 @@ The [previous section](scenario-creation.md) provided documentation on `Scenario^` creation. Now that we know how to create a new `Scenario^`, this section will describe the scenario's attributes and the various utility methods. -In this section, it is assumed that the `my_config.py` +In this section, it is assumed that the `my_config.py` module contains a Taipy configuration already implemented. # Scenario attributes diff --git a/docs/manuals/core/entities/sequence-mgt.md b/docs/manuals/core/entities/sequence-mgt.md index fc7bd823d..1e6ee4ab6 100644 --- a/docs/manuals/core/entities/sequence-mgt.md +++ b/docs/manuals/core/entities/sequence-mgt.md @@ -2,7 +2,7 @@ The [Entities' creation](scenario-creation.md) section provides documentation on that we know how to create a new `Sequence^`, this section focuses on describing the sequence's attributes and utility methods. -In this section, it is assumed that the `my_config.py` +In this section, it is assumed that the `my_config.py` module contains an already implemented configuration. # Sequence attributes diff --git a/docs/manuals/core/entities/task-mgt.md b/docs/manuals/core/entities/task-mgt.md index e6f4e10ba..62868356b 100644 --- a/docs/manuals/core/entities/task-mgt.md +++ b/docs/manuals/core/entities/task-mgt.md @@ -1,7 +1,7 @@ Tasks get created when scenarios are created. Please refer to the [Entities' creation](scenario-creation.md) section for more details. -In this section, it is assumed that `my_config.py` +In this section, it is assumed that `my_config.py` module contains a Taipy configuration already implemented. # Task attributes From 24b9dddac828271b3adf2cdf92aee80d73d139b5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C4=90=E1=BB=97=20Tr=C6=B0=E1=BB=9Dng=20Giang?= Date: Tue, 23 Jan 2024 19:55:02 +0700 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Fabien Lelaquais <86590727+FabienLelaquais@users.noreply.github.com> --- docs/manuals/core/entities/data-node-mgt.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/manuals/core/entities/data-node-mgt.md b/docs/manuals/core/entities/data-node-mgt.md index 0be187eb8..1a9b918ba 100644 --- a/docs/manuals/core/entities/data-node-mgt.md +++ b/docs/manuals/core/entities/data-node-mgt.md @@ -385,7 +385,7 @@ To write with custom column names, use the `CSVDataNode.write_with_column_names( When reading from an Excel data node, Taipy returns the data of the Excel file based on the _exposed_type_ parameter. Check out [Excel Data Node configuration](../config/data-node-config.md#excel) for more details on _exposed_type_. -For the example in this section, assume that `sales_history_cfg` is an _Excel_ data node +For the example in this section, assume that *sales_history_cfg* is an *Excel* data node configuration with `default_path="path/sales.xlsx"`. Assume that the content of the `sales.xlsx` file is the following. @@ -542,7 +542,7 @@ To write with custom column names, use the `ExcelDataNode.write_with_column_name When reading from a SQL Table data node, Taipy returns the data of the SQL Table file based on the _exposed_type_ parameter. Check out [SQL Table Data Node configuration](../config/data-node-config.md#sql-table) for more details on _exposed_type_. -For the example in this section, assume that `sales_history_cfg` is a _SQL Table_ data node configuration with `table_name="sales"`. +For the example in this section, assume that *sales_history_cfg* is a *SQL Table* data node configuration with `table_name="sales"`. Assume that the content of the `"sales"` table is the following. @@ -688,7 +688,7 @@ node: A SQL data node is designed to give the user more flexibility on how to read and write to SQL table (or multiple SQL tables). -Let's consider the `orders_cfg` in `my_config.py` +Let's consider the *orders_cfg* in `my_config.py` which configures a SQL data node. When reading from a SQL data node, Taipy executes the read query and returns the data of the SQL @@ -801,7 +801,7 @@ also encode and decode: - A [`datetime.datetime`](https://docs.python.org/3/library/datetime.html#datetime-objects) object. - A [dataclass](https://docs.python.org/3/library/dataclasses.html) object. -For the example in this section, assume that `sales_history_cfg` is a _JSON_ data node configuration +For the example in this section, assume that *sales_history_cfg* is a *JSON* data node configuration with `default_path="path/sales.json"`. !!! example "Read and write from a JSON data node using default _encoder_ and _decoder_" @@ -1092,7 +1092,7 @@ MongoDB, including but not limited to: - Object (embedded document object). - Arrays − arrays or list or multiple values. -For the example in this section, assume that `sales_history_cfg` is a _Mongo collection_ data node +For the example in this section, assume that *sales_history_cfg* is a *Mongo collection* data node configuration. Check out [MongoDB supported data types](https://www.mongodb.com/docs/manual/reference/bson-types/) for more details.