[DOCS] Fixes post review

francis-clairicia · Sep 21, 2023 · 2698683 · 2698683
1 parent e3cc4be
commit 2698683
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 11 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -17,6 +17,7 @@ on:
       - '.github/**'
       - '!.github/actions/setup-tox/**'
       - '!.github/workflows/build.yml'
+      - 'docs/**'
   push:
     branches:
       - main
@@ -32,6 +33,7 @@ on:
       - '.github/**'
       - '!.github/actions/setup-tox/**'
       - '!.github/workflows/build.yml'
+      - 'docs/**'
   workflow_dispatch:
     inputs:
       SOURCE_DATE_EPOCH:

diff --git a/README.md b/README.md
@@ -35,12 +35,13 @@ pip install --user .
 ```
 
 ## Overview
-EasyNetwork fully encapsulates socket handling, offering you a high-level interface enabling an application/software to fully handle the logic part
-with Python objects without worrying about how to process, send or receive data across the network.
+EasyNetwork completely encapsulates the socket handling, providing you with a higher level interface
+that allows an application/software to completely handle the logic part with Python objects,
+without worrying about how to process, send or receive data over the network.
 
-The communication protocol can be whatever you want, be it JSON, pickle, ASCII, structure, base64 encoded, compressed, encrypted,
-or any other format not part of the standard library.
-You choose the data format, and the library takes care of the rest.
+The communication protocol can be whatever you want, be it JSON, Pickle, ASCII, structure, base64 encoded,
+compressed, encrypted, or any other format that is not part of the standard library.
+You choose the data format and the library takes care of the rest.
 
 Works with TCP and UDP.
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -15,6 +15,7 @@
 copyright = "2023, Francis Clairicia-Rose-Claire-Josephine"
 author = "FrankySnow9"
 release = "1.0.0rc4"
+version = release
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

diff --git a/docs/source/quickstart/install.rst b/docs/source/quickstart/install.rst
@@ -14,7 +14,7 @@ To use EasyNetwork, first install it using :program:`pip`:
 Optional Dependencies
 =====================
 
-EasyNetwork has no required dependencies, but the library comes with a bunch of optional dependencies to meet specific needs.
+EasyNetwork has no required dependencies, but comes with many optional dependencies to meet specific needs.
 
 Here is the full list:
 

diff --git a/docs/source/quickstart/overview.rst b/docs/source/quickstart/overview.rst
@@ -2,11 +2,12 @@
 Overview
 ********
 
-EasyNetwork fully encapsulates socket handling, offering you a high-level interface enabling an application/software to fully handle the logic part
-with Python objects without worrying about how to process, send or receive data across the network.
+EasyNetwork completely encapsulates the socket handling, providing you with a higher level interface
+that allows an application/software to completely handle the logic part with Python objects,
+without worrying about how to process, send or receive data over the network.
 
-The communication protocol can be whatever you want, be it JSON, pickle, ASCII, structure, base64 encoded, compressed, encrypted,
-or any other format not part of the standard library.
-You choose the data format, and the library takes care of the rest.
+The communication protocol can be whatever you want, be it JSON, Pickle, ASCII, structure, base64 encoded,
+compressed, encrypted, or any other format that is not part of the standard library.
+You choose the data format and the library takes care of the rest.
 
 Works with TCP and UDP.