Skip to content

docs: add docstring and return type to DotFlow.result()#87

Closed
alexkore12 wants to merge 1 commit intodotflow-io:developfrom
alexkore12:fix/issue-83-add-docstring
Closed

docs: add docstring and return type to DotFlow.result()#87
alexkore12 wants to merge 1 commit intodotflow-io:developfrom
alexkore12:fix/issue-83-add-docstring

Conversation

@alexkore12
Copy link
Copy Markdown
Contributor

Summary

Fixes #83

Adds the missing docstring to DotFlow.result() for consistency with the other result_* methods.

Changes

  • Added docstring to result() method describing its return value
  • Added -> dict return type annotation

Before

def result(self):
    return self.task.result()

After

def result(self) -> dict:
    """
    Returns:
        dict: Returns the full workflow result serialized as a dictionary,
              including workflow ID and all task schemas.
    """
    return self.task.result()

Add missing docstring to DotFlow.result() method for API consistency
with result_task(), result_context(), and result_storage().

Also adds -> dict return type annotation.

Closes dotflow-io#83
@FernandoCelmer FernandoCelmer changed the base branch from master to develop March 26, 2026 15:57
@FernandoCelmer
Copy link
Copy Markdown
Member

Thanks for the contribution, @alexkore12! 🎉

The docstring addition was already merged via PR #86. Your other PR #94 (execution typo fix) has been merged. Thanks for your contributions!

@FernandoCelmer FernandoCelmer added duplicate This issue or pull request already exists documentation Improvements or additions to documentation labels Mar 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation duplicate This issue or pull request already exists

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DotFlow.result() is missing a docstring

2 participants