docs: improve grammar and style

eduNEXT · Oct 27, 2023 · 8e8f2c7 · 8e8f2c7
1 parent 21facc0
commit 8e8f2c7
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/docs/source/decisions/0002-api-connection.rst b/docs/source/decisions/0002-api-connection.rst
@@ -22,7 +22,7 @@ Decisions
 - We use the LMS APIs to do the basic functionalities.
     - To obtain info about enrollments, we use ``GET /enrollment/v1/enrollments/``
     - To create enrollments, ``POST /enrollment/v1/enrollment``
-    - To perform an unenroll, we use the same endpoint to create enrollment, but we set the attribute is_active in False.
+    - To perform an unenroll, we use the same endpoint to create enrollment, but we set the attribute is_active in ``False``.
     - We can pass the flag force in the request to allow you to enroll; disregard the course's enrollment end dates.
     - To know if a user exists in the platform, ``GET /user/v1/accounts``
     - If the user does not exist yet, we can get, create, or delete an enrollment allowed with: ``GET, POST, DELETE /api/enrollment/v1/enrollment_allowed/``
@@ -34,7 +34,7 @@ Consequences
 - You need to create an OAuth Application in your platform with a Staff user to use this plugin.
 - The backward compatibility depends on the JWT support in previous Open edx versions.
 - We can use the course enrollment allowed API since Quince.
-- The actions of this plugin are restricted by the endpoints mentioned above. For example, We can't enroll someone in a course that is in invite-only mode.
+- The actions of this plugin are restricted by the endpoints mentioned above. For example, we cannot enroll someone in a course that is in invite-only mode.
 
 
 Rejected Alternatives

diff --git a/docs/source/decisions/0003-fulfillment-and-refund.rst b/docs/source/decisions/0003-fulfillment-and-refund.rst
@@ -13,7 +13,7 @@ Context
 This plugin was created focusing on workflows that are streamlined:
 
 - A course bought in WooCommerce will have the consequence that the enrollment for that course is made in the Open edX platform, understood with the enrollment as a seat in a specific course run.
-- If the order is refunded, the associated enrollment will be unenrolled using the soft delete(using the is_active flag) used in regular unenrollments.
+- If the order is refunded, the associated enrollment will be unenrolled using the soft delete (using the is_active flag) used in regular unenrollments.
 
 
 Decisions
@@ -35,9 +35,9 @@ Screenshot of a refund process marking the course to be refunded.
 
 Consequences
 ************
-- We shouldn't set our Open edX Courses as Downloables WooCommerce Products because if that happened and someone only bought downloadable products, the order never passed through the 'processing' status. The plugin wouldn't create the enrollment request.
-- Refunding is a manual process; a customer can't do it alone.
-- It is our responsibility to avoid enrollment errors by setting our product as an Open edX course and setting a correct course_id and course_mode to the enrollment trigger by an order will be performed well.
+- We should not set our Open edX Courses as Downloadable WooCommerce Products because if that happened and someone only bought downloadable products, the order never passed through the 'processing' status. The plugin would not create the enrollment request.
+- Refunding is a manual process; a customer cannot do it alone.
+- It is our responsibility to avoid enrollment errors by setting our product as an Open edX course and setting a correct ``course_id`` and ``course_mode`` to the enrollment trigger by an order will be performed well.
 
 
 Rejected Alternatives