Merge pull request #111 from JIR-22

* Update apis.rst
* Corrected a few grammatical sentences on the `export_issues` method

CHANGES.md

@@ -1,20 +1,24 @@
 # Jira one change log
 
+**Release 0.7.7** - 2023-06-14
+### Minor update #111
+* Added minor updates to the `export_issues` method. Corrected some few grammatical errors
+
 **Release 0.7.6** - 2023-05-27
 ### Minor update #110
-* Added multiple arguments to `issue_export` method
-  * It is now possible to perform an export in JSON format
+* Added multiple arguments to the `issue_export` method
+  * It is now possible to perform export in JSON format
   * Added field exclusion and inclusion in CSV format export
 * Added new methods `get_project_versions` and `issue_link_types` to access.py module
 * Added a `process_executor` function, regular express constants and a `DateFormat` class to 
 the utils module of jiraone.
-* Added examples in documentations
+* Added examples in the documentation
 
 
 **Release 0.7.5** - 2023-03-16
 ### Update #109
-* Added a new condition to use encoding argument in `file_writer` in text mode
-* Added examples in documentations
+* Added a new condition to using encoding argument in `file_writer` in text mode
+* Added examples in documentation
 
 
 **Release 0.7.4** - 2023-03-13

SECURITY.md

@@ -2,10 +2,11 @@
 
 ## Supported Versions
 
-Below shows the list of supported version for the jiraone library
+Below shows the list of supported versions for the jiraone library
 
 | Version | Supported          |
 |---------|--------------------|
+| 0.7.7   | :white_check_mark: |
 | 0.7.6   | :white_check_mark: |
 | 0.7.5   | :white_check_mark: |
 | 0.7.4   | :white_check_mark: |

docs/apis.rst

@@ -70,7 +70,7 @@ You can access this class and make updates to Jira fields.
   
   # previous login statement
   issue = "T6-75"
-  fields = "Multiple files" # a multiselect custom field
+  fields = "Multiple files" # a multi-select custom field
   case_value = ["COM Row 1", "Thanos"]
   for value in case_value:
       c = field.update_field_data(data=value, find_field=fields, key_or_id=issue, options="add", show=False)
@@ -95,7 +95,7 @@ For
 manage
 ----------
 
-The ``manage`` class is a alias to ``UserManagement`` class of the ``management`` module. It focuses primarily on
+The ``manage`` class is an alias to the ``UserManagement`` class of the ``management`` module. It focuses primarily on
 user and organization management. The authentication is different as it uses a bearer token.
 
 .. code-block:: python
@@ -156,7 +156,7 @@ USER
 Module
 ---------
 
-The ``module`` module contains functions that are specific towards certain task. Each function is designed to be as straightforward
+The ``module`` module contains functions that are specific towards a certain task. Each function is designed to be as straightforward
 as possible, so you can easily make calls to Jira's endpoint and get the required data.
 
 .. code-block:: python
@@ -199,7 +199,7 @@ Utils
 .. autoclass:: DotNotation
    :members:
 
-This ``DotNotation`` class provides the ability of using a dot notation on any dict object. Making it easier when working with dictionary objects.
+This ``DotNotation`` class provides the ability to use a dot notation on any dict object. Making it easier when working with dictionary objects.
 Examples below
 
 .. code-block:: python
@@ -222,4 +222,32 @@ Examples below
     
 .. note::
 
-   When loading a list of dictionary, please refer to the second example as shown on the above code. The dictionary needs to be assigned to a key (any naming convention will do) to get the value. Failure will result in an error.
+   When loading a list of dictionaries, please refer to the second example as shown on the above code. The dictionary needs to be assigned to a key (any naming convention will do) to get the value. Failure will result in an error.
+
+.. autoclass:: DateFormat
+    :members:
+
+The ``DateFormat`` class provides the ability to construct datetime string directive which is used in Python's datetime class.
+
+.. code-block:: python
+    
+    from jiraone.utils import DateFormat
+    
+    my_date = DateFormat.dd_MM_YYYY_hh_MM_AM_PM
+
+.. autofunction:: process_executor
+
+The ``process_executor`` helps to generate multiple threads used to make HTTP requests. To properly use this function,
+you should pass a function which has an argument in a ``for`` loop to begin the iteration. You can increase the number of
+threads to start with by increasing the ``workers`` argument
+
+.. code-block:: python
+
+    from jiraone.utils import process_executor
+    
+    # a function called extract_issues(data)
+    # list_items a list of data
+    for items in list_items
+        process_executor(extract_issues, data=items)
+        
+ 

jiraone/__init__.py

@@ -36,7 +36,7 @@
 from jiraone.management import manage
 
 __author__ = "Prince Nyeche"
-__version__ = "0.7.6"
+__version__ = "0.7.7"
 __all__ = [
     "LOGIN",
     "endpoint",