Doc/corrections to premium as default (#867)

* Corrections from comments on initial PR

* Improve description of the LicenseContextManager in the example.

* Update examples/00-basic/13-manage_licensing.py

Co-authored-by: JennaPaikowsky <[email protected]>

---------

Co-authored-by: JennaPaikowsky <[email protected]>

Author: PProfizi

docs/source/user_guide/getting_started_with_dpf_server.rst

@@ -133,7 +133,7 @@ DPF Server is protected by an Ansys licensing mechanism.
 
 DPF capabilities are available through the following main contexts:
 
-- **Premium:** This context, which is the default, allows DPF to perform license checkouts,
+- **Premium:** This default context allows DPF to perform license checkouts,
   making licensed DPF operators available.
 - **Entry:** This context does not allow DPF to perform any license checkout,
   meaning that licensed DPF operators fail.

docs/source/user_guide/server_context.rst

@@ -18,7 +18,7 @@ class and :ref:`user_guide_xmlfiles`.
 
 Two main licensing context type capabilities are available: 
 
-- **Premium:** This context, which is the default, allows DPF to perform license checkouts,
+- **Premium:** This default context allows DPF to perform license checkouts,
   making licensed DPF operators available.
 - **Entry:** This context does not allow DPF to perform any license checkout,
   meaning that licensed DPF operators fail.
@@ -82,11 +82,11 @@ with this code:
     Server Context of type LicensingContextType.entry with no xml path
 
 .. warning::
-    As starting an ``InProcess`` server means linking the DPF binaries to your current python
+    As starting an ``InProcess`` server means linking the DPF binaries to your current Python
     process, you cannot start a new ``InProcess`` server. Thus, if your local ``InProcess`` server
     is already **Premium**, you cannot set it back as **Entry**.
     ``InProcess`` being the default server type, the proper commands to work as **Entry** should be
-    set right at the beginning of your script.
+    set at the start of your script.
 
 
 

examples/00-basic/13-manage_licensing.py

@@ -1,20 +1,20 @@
 """
 .. _ref_manage_licensing:
 
-Manage the DPF licensing logic via the server context
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Manage the DPF licensing logic using the server context
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-This examples shows how to manage the licensing logic of a DPF server using a `ServerContext`.
+This example shows how to manage the licensing logic of a DPF server using a `ServerContext`.
 
-Preventing DPF from checking licenses out and blocking increments is possible
-with the **Entry** context.
+You can prevent DPF from checking licenses out and blocking increments by using the
+**Entry** context.
 
 .. warning::
-    As starting an ``InProcess`` server means linking the DPF binaries to your current python
-    process, you cannot start a new ``InProcess`` server. Thus, if your local ``InProcess`` server
-    is already **Premium**, you cannot set it back as **Entry**.
-    ``InProcess`` being the default server type, the proper commands to work as **Entry** should be
-    set right at the beginning of your script.
+    You cannot start a new ``InProcess`` server, as starting an ``InProcess`` server means linking
+    the DPF binaries to your current Python process. If your local ``InProcess`` server is already
+    set to **Premium**, you cannot set it back to **Entry**.
+    Since ``InProcess`` is the default server type, put the commands to set the **Entry** server
+    context at the start of your script.
 
 .. note::
     This example requires DPF 6.1 (Ansys 2023R2) or above.
@@ -35,7 +35,7 @@
 # The context is shown as Entry
 print(server.context)
 
-# A server of type InProcess being linked to the current python process,
+# A server of type InProcess being linked to the current Python process,
 # if an InProcess server already exists as Premium, you cannot set it back as Entry.
 
 #######################################################################################
@@ -75,8 +75,10 @@
 out = op_premium.eval()
 print(out)
 
-###############################################################################################
-# When Premium, using a LicenseContextManaged allows to control your interaction with a license
+###################################################################################################
+# When Premium, using a LicenseContextManaged allows you to control your interaction with a license
+# It gives direct control over when the license check-out and check-in occur, as well as which
+# license increment is used, and for what maximum duration.
 
 # Use the LicenseContextManager to block a specific increment for a limited duration
 with dpf.LicenseContextManager(increment_name="preppost", license_timeout_in_seconds=1.0) as lic:

src/ansys/dpf/core/operator_specification.py

@@ -461,7 +461,7 @@ class SpecificationProperties:
         Snake case name of the plugin it belongs to.
 
     license: str
-        Optional license name to check out to run the operator.
+        Optional license name to check out that is used to run the operator.
         The value "any_dpf_supported_increments" tells DPF than any DPF-accepted license
         is accepted by this operator (see `here
         <https://dpf.docs.pyansys.com/version/stable/user_guide/getting_started_with_dpf_server.html#ansys-licensing>`_).  # noqa

src/ansys/dpf/core/server_context.py

@@ -3,7 +3,7 @@
 =============
 
 Gives the ability to choose the context with which the server should be started.
-The context allows to choose the licensing logic for operators.
+The context allows you to choose the licensing logic for operators.
 For every context, DPF always checks if an Ansys license is available.
 By default, a **Premium** type of :class:`ServerContext` is used,
 meaning that any operator requiring a license check-out can do so.