Updated docs

2025-03-18 16:32:54 +03:00
parent 990508eb32
commit 6b6a0202a4
3 changed files with 14 additions and 2 deletions
--- a/docs/focus.rst
+++ b/docs/focus.rst
@@ -44,8 +44,20 @@

 .. autofunction:: kontur_focus.Focus.excerpt(path)

+Пример вывода результат по отчету:
+
+.. code-block:: python
+
+    {'success': True, 'filename': '<имя_файла>', 'path': '<полный_путь_файла>'}
+
 .. autofunction:: kontur_focus.Focus.express_report(pdf, path)

+Пример вывода результат по отчету:
+
+.. code-block:: python
+
+    {'success': True, 'filename': '<имя_файла>', 'path': '<полный_путь_файла>'}
+
 .. autofunction:: kontur_focus.Focus.founders_history()

 .. autofunction:: kontur_focus.Focus.foreign_representatives()
--- a/kontur_focus/focus.py
+++ b/kontur_focus/focus.py
@@ -37,7 +37,7 @@ class Focus(Request):

        :param path: Путь выгрузки файла. Если не указан, выгружается в текущий каталог.
        :type path: str, необязательный
-        :return: Результат и путьвыгрузки
+        :return: Результат, имя файла и путь выгрузки
        :rtype: str
        """
        response = self.get('/excerpt')
--- a/setup.py
+++ b/setup.py
@@ -2,7 +2,7 @@ from setuptools import setup, find_packages

 setup(
    name="kontur_focus",
-    version="0.2.2",
+    version="0.2.3",
    author="Ilya Sapunov",
    author_email="sapunov@selectel.ru",
    description="Библиотека-обертка для взаимодействия с REST API Контур.Фокус и Фокус.Комплаенс",