Merge pull request #583 from Cohen-J-Omer/alter_documentation

gilv · web-flow · commit 9507cbf7e8e4 · 2021-03-07T06:49:26.000+02:00
Made small-scale corrections to documentation (e.g. broken links).
diff --git a/config/README.md b/config/README.md
@@ -4,7 +4,7 @@ To work with Lithops you must configure both compute backend and a storage. Fail
 
 Lithops can work with almost any compute backend and storage any can be used with almost any cloud provider. You have multiple options to choose compute backend and storage backend based on your needs. 
 
-After you choose your compute and storage engine, you need to configure Lithops so it can use choosen compute and storage. Lithops configuration can be provided either in configuration file or provided in runtime via Python dictionary. 
+After you choose your compute and storage engine, you need to configure Lithops so it can use chosen compute and storage. Lithops configuration can be provided either in configuration file or provided in runtime via Python dictionary. 
 
 ## Lithops configuration
 
@@ -109,7 +109,7 @@ def hello_world(name):
 
 if __name__ == '__main__':
     fexec = lithops.FunctionExecutor()
-    fexec.call_async(hello, 'World')
+    fexec.call_async(hello_world, 'World')
     print(fexec.get_result())
 ```
 
@@ -133,7 +133,7 @@ def hello_world(name):
 
 if __name__ == '__main__':
     fexec = lithops.FunctionExecutor(config=config)
-    fexec.call_async(hello, 'World')
+    fexec.call_async(hello_world, 'World')
     print(fexec.get_result())
 ```
 
diff --git a/config/storage/ibm_cos.md b/config/storage/ibm_cos.md
@@ -32,23 +32,23 @@ Alternative to using region, you can configre public and private endpoints as fo
 
 ### Configuration
 
-5. Login to IBM Cloud and open up your dashboard. Then navigate to your instance of Object Storage.
+1. Login to IBM Cloud and open up your dashboard. Then navigate to your instance of Object Storage.
 
-6. In the side navigation, click `Endpoints` to find your API endpoint. You must copy both public and private endpoints of the region where you created your bucket.
+2. In the side navigation, click `Endpoints` to find your API endpoint. You must copy both public and private endpoints of the region where you created your bucket.
 
-7. Create the credentials to access to your COS account (Choose one option):
+3. Create the credentials to access to your COS account (Choose one option):
  
 #### Option 1 (COS API Key):
 
-8. In the side navigation, click `Service Credentials`.
+4. In the side navigation, click `Service Credentials`.
 
-9. Click `New credential +` and provide the necessary information.
+5. Click `New credential +` and provide the necessary information.
 
-10. Click `Add` to generate service credential.
+6. Click `Add` to generate service credential.
 
-11. Click `View credentials` and copy the *apikey* value.
+7. Click `View credentials` and copy the *apikey* value.
 
-12. Edit your lithops config file and add the following keys:
+8. Edit your lithops config file and add the following keys:
 
     ```yaml
     lithops:
@@ -62,17 +62,17 @@ Alternative to using region, you can configre public and private endpoints as fo
 
 #### Option 2 (COS HMAC credentials):
 
-13. In the side navigation, click `Service Credentials`.
+4. In the side navigation, click `Service Credentials`.
 
-14. Click `New credential +`.
+5. Click `New credential +`.
 
-15. Click on advanced options and enable `Include HMAC Credential` button. 
+6. Click on advanced options and enable `Include HMAC Credential` button. 
 
-16. Click `Add` to generate service credential.
+7. Click `Add` to generate service credential.
 
-17. Click `View credentials` and copy the *access_key_id* and *secret_access_key* values.
+8. Click `View credentials` and copy the *access_key_id* and *secret_access_key* values.
 
-18. Edit your lithops config file and add the following keys:
+9. Edit your lithops config file and add the following keys:
     ```yaml
     lithops:
         storage: ibm_cos
@@ -86,13 +86,13 @@ Alternative to using region, you can configre public and private endpoints as fo
 
 #### Option 3 (IBM IAM API Key):
 
-19. If you don't have an IAM API key created, navigate to the [IBM IAM dashboard](https://cloud.ibm.com/iam/apikeys)
+4. If you don't have an IAM API key created, navigate to the [IBM IAM dashboard](https://cloud.ibm.com/iam/apikeys)
 
-20. Click `Create an IBM Cloud API Key` and provide the necessary information.
+5. Click `Create an IBM Cloud API Key` and provide the necessary information.
 
-21. Copy the generated IAM API key (You can only see the key the first time you create it, so make sure to copy it).
+6. Copy the generated IAM API key (You can only see the key the first time you create it, so make sure to copy it).
 
-22. Edit your lithops config file and add the following keys:
+7. Edit your lithops config file and add the following keys:
     ```yaml
     lithops:
         storage_backend: ibm_cos
diff --git a/docs/api_futures.md b/docs/api_futures.md
@@ -21,13 +21,13 @@ The available calls within an executor are:
 
 |API Call| Type | Description|
 |---|---|---|
-|[call_async()](api-details.md#executorcall_async) | Async. | Method used to spawn one function activation |
-|[map()](api-details.md#executormap) | Async. | Method used to spawn multiple function activations |
-|[map_reduce()](api-details.md#executormap_reduce) | Async. | Method used to spawn multiple function activations with one (or multiple) reducers|
-|[wait()](api-details.md#executorwait) | Sync. | Wait for the function activations to complete. It blocks the local execution until all the function activations finished their execution (configurable)|
-|[get_result()](api-details.md#executorget_result) | Sync. | Method used to retrieve the results of all function activations. The results are returned within an ordered list, where each element of the list is the result of one activation|
-|[plot()](api-details.md#executorplot) | Sync. | Method used to create execution plots |
-|[clean()](api-details.md#executorclean) | Async. | Method used to clean the temporary data generated by Lithops|
+|[call_async()](api_futures.md#executorcall_async) | Async. | Method used to spawn one function activation |
+|[map()](api_futures.md#executormap) | Async. | Method used to spawn multiple function activations |
+|[map_reduce()](api_futures.md#executormap_reduce) | Async. | Method used to spawn multiple function activations with one (or multiple) reducers|
+|[wait()](api_futures.md#executorwait) | Sync. | Wait for the function activations to complete. It blocks the local execution until all the function activations finished their execution (configurable)|
+|[get_result()](api_futures.md#executorget_result) | Sync. | Method used to retrieve the results of all function activations. The results are returned within an ordered list, where each element of the list is the result of one activation|
+|[plot()](api_futures.md#executorplot) | Sync. | Method used to create execution plots |
+|[clean()](api_futures.md#executorclean) | Async. | Method used to clean the temporary data generated by Lithops|
 
 
 **LocalhostExecutor(\*\*kwargs)**
@@ -41,7 +41,7 @@ Initialize and return Localhost executor object.
 |workers | cpu_count | Max number of parallel workers |
 |storage | localhost | Storage backend to store temp data|
 |rabbitmq_monitor | False | Activate RabbitMQ monitoring |
-|log_level | INFO | Log level printing (INFO, DEBUG, ...). Set it to None to hide all logs. If this is param is set, al logging params in config are disabled|
+|log_level | INFO | Log level printing (INFO, DEBUG, ...). Set it to None to hide all logs. If this is param is set, all logging params in config are disabled|
 
 Usage:
 
diff --git a/docs/api_storage.md b/docs/api_storage.md
@@ -1,6 +1,6 @@
 # Lithops Storage API Details
 
-Lithops allows to create a **Storage** instance and abstract away the backend implementation details. The standard way to get an Storage object set up is to import the lithops `Storage` class and create an instance.
+Lithops allows to create a **Storage** instance and abstract away the backend implementation details. The standard way to get a Storage object set up is to import the lithops `Storage` class and create an instance.
 
 
 **Storage(\*\*kwargs)**
@@ -33,7 +33,7 @@ config = {'lithops' : {'storage' : 'ibm_cos'},
 storage = Storage(config=config)
 ```
 
-In such a case you have multiple storage set in your configuration, you can force the storage backend by using the `backend` parameter:
+In case you have multiple storage set in your configuration, you can force the storage backend by using the `backend` parameter:
 
 ```python
 from lithops import Storage
@@ -192,7 +192,7 @@ Returns all of the objects in a bucket. For each object, the list contains the n
 
 ### `Storage.list_keys()`
 
-Similar to lit_objects(), it returns all of the objects in a bucket. For each object, the list contains only the names of the objects (keys).
+Similar to list_objects(), it returns all of the objects in a bucket. For each object, the list contains only the names of the objects (keys).
 
 **list_keys**(bucket, \*\*kwargs)
 
diff --git a/examples/multiprocessing/pool.py b/examples/multiprocessing/pool.py
@@ -28,7 +28,7 @@ def sleep_seconds(s):
 if __name__ == '__main__':
     with Pool() as pool:
 
-        # Synchronously execute function square remotely
+        # Synchronously execute function hello remotely
         res = pool.apply(hello, ('World', ))
         print(res)  # print "Hello World!"
 
