Browse Source

Apply suggestions from code review

Co-authored-by: Fabien Lelaquais <86590727+FabienLelaquais@users.noreply.github.com>
Đỗ Trường Giang 1 year ago
parent
commit
f4d9df6964
3 changed files with 9 additions and 9 deletions
  1. 1 1
      taipy/config/CONTRIBUTING.md
  2. 3 3
      taipy/config/INSTALLATION.md
  3. 5 5
      taipy/config/README.md

+ 1 - 1
taipy/config/CONTRIBUTING.md

@@ -95,7 +95,7 @@ working on it.
 
 
 3. For convention help, we provide a [pre-commit](https://pre-commit.com/hooks.html) file.
 3. For convention help, we provide a [pre-commit](https://pre-commit.com/hooks.html) file.
    This tool will run before each commit and will automatically reformat code or raise warnings and errors based on the
    This tool will run before each commit and will automatically reformat code or raise warnings and errors based on the
-   code format or Python typing.
+   code format or Python typing.<br/>
    You can install and setup it up by doing:
    You can install and setup it up by doing:
    ```bash
    ```bash
    $ pipenv install pre-commit
    $ pipenv install pre-commit

+ 3 - 3
taipy/config/INSTALLATION.md

@@ -1,13 +1,13 @@
 # Installation
 # Installation
 
 
-The latest stable version of _taipy-config_ is available through _pip_:
+The latest stable version of *taipy-config* can be installed using `pip`:
 ```bash
 ```bash
 $ pip install taipy-config
 $ pip install taipy-config
 ```
 ```
 
 
 ## Development version
 ## Development version
 
 
-You can install the development version of _taipy-config_ with _pip_ and _git_ via the taipy repository:
+You can install the development version of *taipy-config* with `pip` and `git` directly from the Taipy repository:
 ```bash
 ```bash
 $ pip install git+https://git@github.com/Avaiga/taipy
 $ pip install git+https://git@github.com/Avaiga/taipy
 ```
 ```
@@ -36,7 +36,7 @@ $ pip install pipenv
 $ pipenv install --dev
 $ pipenv install --dev
 ```
 ```
 
 
-Then you can run _taipy-config_ tests with the following command:
+Then you can run *taipy-config* tests with the following command:
 
 
 ```bash
 ```bash
 $ pipenv run pytest tests/config
 $ pipenv run pytest tests/config

+ 5 - 5
taipy/config/README.md

@@ -26,7 +26,7 @@ Taipy is a Python library for creating Business Applications. More information o
 [website](https://www.taipy.io). Taipy is split into multiple repositories including _taipy-config_ to let users
 [website](https://www.taipy.io). Taipy is split into multiple repositories including _taipy-config_ to let users
 install the minimum they need.
 install the minimum they need.
 
 
-Taipy config is dedicated to helping the user configure a Taipy application.
+Taipy config is a package designed to help users configure their Taipy application.
 
 
 More in-depth documentation of taipy can be found [here](https://docs.taipy.io).
 More in-depth documentation of taipy can be found [here](https://docs.taipy.io).
 
 
@@ -50,10 +50,10 @@ Want to be part of the _Taipy config_ community? Check out our [`CODE_OF_CONDUCT
     - `_serializer/`: Internal package for serializing and deserializing configurations.
     - `_serializer/`: Internal package for serializing and deserializing configurations.
     - `checker/`: Configuration checker and issue collector implementation.
     - `checker/`: Configuration checker and issue collector implementation.
     - `common/`: Shared data structures, types, and functions.
     - `common/`: Shared data structures, types, and functions.
-    - `exceptions/`: _taipy-config_ exceptions.
-    - `global_app/`: GlobalAppConfig implementation.
-    - `stubs/`: Helper functions to create the _config.pyi_ file.
-    - `CODE_OF_CONDUCT.md`: Code of conduct for members and contributors of _taipy-config_.
+    - `exceptions/`: *taipy-config* exceptions.
+    - `global_app/`: `GlobalAppConfig` implementation.
+    - `stubs/`: Helper functions to create the `config.pyi` file.
+    - `CODE_OF_CONDUCT.md`: Code of conduct for members and contributors of *taipy-config*.
     - `CONTRIBUTING.md`: Instructions to contribute to _taipy-config_.
     - `CONTRIBUTING.md`: Instructions to contribute to _taipy-config_.
     - `INSTALLATION.md`: Instructions to install _taipy-config_.
     - `INSTALLATION.md`: Instructions to install _taipy-config_.
     - `LICENSE`: The Apache 2.0 License.
     - `LICENSE`: The Apache 2.0 License.