Added comment to classes: "avalaible as XXX.path" (#225)

Signed-off-by: Alexander Piskun <bigcat88@icloud.com>

Author: bigcat88

docs/reference/Files/Shares.rst

@@ -2,7 +2,6 @@ File Sharing
 ============
 
 The Shares API is universal for both modes and provides all the necessary methods for working with the Nextcloud Shares system.
-Refer to the `Sharing examples <https://github.com/cloud-py-api/nc_py_api/tree/main/examples/as_client/sharing>`_ to see how to use them nicely.
 
 .. autoclass:: nc_py_api.files.sharing._FilesSharingAPI
     :members:

nc_py_api/_preferences_ex.py

@@ -106,7 +106,7 @@ async def delete(self, keys: str | list[str], not_fail=True) -> None:
 
 
 class PreferencesExAPI(_BasicAppCfgPref):
-    """User specific preferences API, avalaible as **nc.preferences_ex**."""
+    """User specific preferences API, avalaible as **nc.preferences_ex.<method>**."""
 
     _url_suffix = "ex-app/preference"
 
@@ -134,7 +134,7 @@ async def set_value(self, key: str, value: str) -> None:
 
 
 class AppConfigExAPI(_BasicAppCfgPref):
-    """Non-user(App) specific preferences API, avalaible as **nc.appconfig_ex**."""
+    """Non-user(App) specific preferences API, avalaible as **nc.appconfig_ex.<method>**."""
 
     _url_suffix = "ex-app/config"
 

nc_py_api/_talk_api.py

@@ -26,7 +26,7 @@
 
 
 class _TalkAPI:
-    """Class provides API to work with Nextcloud Talk."""
+    """Class provides API to work with Nextcloud Talk, avalaible as **nc.talk.<method>**."""
 
     _ep_base: str = "/ocs/v2.php/apps/spreed"
     config_sha: str

nc_py_api/ex_app/providers/speech_to_text.py

@@ -37,7 +37,7 @@ def __repr__(self):
 
 
 class _SpeechToTextProviderAPI:
-    """API for Speech2Text providers."""
+    """API for Speech2Text providers, avalaible as **nc.providers.text_processing.<method>**."""
 
     def __init__(self, session: NcSessionApp):
         self._session = session
@@ -83,7 +83,7 @@ def report_result(self, task_id: int, result: str = "", error: str = "") -> None
 
 
 class _AsyncSpeechToTextProviderAPI:
-    """API for Speech2Text providers."""
+    """Async API for Speech2Text providers."""
 
     def __init__(self, session: AsyncNcSessionApp):
         self._session = session

nc_py_api/ex_app/providers/text_processing.py

@@ -42,7 +42,7 @@ def __repr__(self):
 
 
 class _TextProcessingProviderAPI:
-    """API for TextProcessing providers."""
+    """API for TextProcessing providers, avalaible as **nc.providers.speech_to_text.<method>**."""
 
     def __init__(self, session: NcSessionApp):
         self._session = session
@@ -89,7 +89,7 @@ def report_result(self, task_id: int, result: str = "", error: str = "") -> None
 
 
 class _AsyncTextProcessingProviderAPI:
-    """API for TextProcessing providers."""
+    """Async API for TextProcessing providers."""
 
     def __init__(self, session: AsyncNcSessionApp):
         self._session = session

nc_py_api/ex_app/providers/translations.py

@@ -47,7 +47,7 @@ def __repr__(self):
 
 
 class _TranslationsProviderAPI:
-    """API for Translations providers."""
+    """API for Translations providers, avalaible as **nc.providers.translations.<method>**."""
 
     def __init__(self, session: NcSessionApp):
         self._session = session
@@ -102,7 +102,7 @@ def report_result(self, task_id: int, result: str = "", error: str = "") -> None
 
 
 class _AsyncTranslationsProviderAPI:
-    """API for Translations providers."""
+    """Async API for Translations providers."""
 
     def __init__(self, session: AsyncNcSessionApp):
         self._session = session

nc_py_api/ex_app/ui/files_actions.py

@@ -119,7 +119,7 @@ def to_fs_node(self) -> FsNode:
 
 
 class _UiFilesActionsAPI:
-    """API for the drop-down menu in Nextcloud **Files app**."""
+    """API for the drop-down menu in Nextcloud **Files app**, avalaible as **nc.ui.files_dropdown_menu.<method>**."""
 
     _ep_suffix: str = "ui/files-actions-menu"
 

nc_py_api/ex_app/ui/resources.py

@@ -77,7 +77,7 @@ def __repr__(self):
 
 
 class _UiResources:
-    """API for adding scripts, styles, initial-states to the TopMenu pages."""
+    """API for adding scripts, styles, initial-states to the pages, avalaible as **nc.ui.resources.<method>**."""
 
     _ep_suffix_init_state: str = "ui/initial-state"
     _ep_suffix_js: str = "ui/script"

nc_py_api/ex_app/ui/settings.py

@@ -115,7 +115,7 @@ def to_dict(self) -> dict:
 
 
 class _DeclarativeSettingsAPI:
-    """Class providing API for creating UI for the ExApp settings."""
+    """Class providing API for creating UI for the ExApp settings, avalaible as **nc.ui.settings.<method>**."""
 
     def __init__(self, session: NcSessionApp):
         self._session = session

nc_py_api/ex_app/ui/top_menu.py

@@ -44,7 +44,7 @@ def __repr__(self):
 
 
 class _UiTopMenuAPI:
-    """API for the top menu app nav bar in Nextcloud."""
+    """API for the top menu app nav bar in Nextcloud, avalaible as **nc.ui.top_menu.<method>**."""
 
     _ep_suffix: str = "ui/top-menu"