Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dimastbk committed Jan 13, 2025
1 parent 4fb6e8d commit 18ead7a
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/errors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ All ``pyzeebe`` errors inherit from :py:class:`PyZeebeError`

.. autoexception:: pyzeebe.errors.ProcessInvalidError

.. autoexception:: pyzeebe.errors.DecisionNotFoundError

.. autoexception:: pyzeebe.errors.InvalidJSONError

.. autoexception:: pyzeebe.errors.ZeebeError
Expand Down
10 changes: 10 additions & 0 deletions docs/zeebe_adapter_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@ Zeebe GRPC Responses
:undoc-members:
:member-order: bysource

.. autoclass:: pyzeebe.grpc_internals.types.EvaluateDecisionResponse
:members:
:undoc-members:
:member-order: bysource

.. autoclass:: pyzeebe.grpc_internals.types.BroadcastSignalResponse
:members:
:undoc-members:
Expand All @@ -56,3 +61,8 @@ Zeebe GRPC Responses
:members:
:undoc-members:
:member-order: bysource

.. autoclass:: pyzeebe.grpc_internals.types.TopologyResponse
:members:
:undoc-members:
:member-order: bysource
2 changes: 1 addition & 1 deletion pyzeebe/client/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ async def evaluate_decision(
) -> EvaluateDecisionResponse:
"""Evaluates a decision.
You specify the decision to evaluate either by using its unique KEY (as returned by :py:method:`ZeebeClient.deploy_resource`), or using the decision ID.
You specify the decision to evaluate either by using its unique KEY (as returned by :py:meth:`ZeebeClient.deploy_resource`), or using the decision ID.
When using the decision ID, the latest deployed version of the decision is used.
Args:
Expand Down

0 comments on commit 18ead7a

Please sign in to comment.