Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add distributed.print and distributed.warn to API docs #7113

Closed
wants to merge 2 commits into from

Conversation

jrbourbeau
Copy link
Member

Following up on #5217, this PR adds distributed.print and distributed.warn to the API docs

@phobson
Copy link

phobson commented Oct 5, 2022

Docstrings could use some formatting, but this passes the scout's campsite test

image

@github-actions
Copy link
Contributor

github-actions bot commented Oct 5, 2022

Unit Test Results

See test report for an extended history of previous test failures. This is useful for diagnosing flaky tests.

       15 files  ±    0         15 suites  ±0   6h 11m 46s ⏱️ + 7m 38s
  3 155 tests ±    0    3 069 ✔️  -     1    84 💤 ±  0  2 +1 
23 350 runs  +883  22 440 ✔️ +859  908 💤 +23  2 +1 

For more details on these failures, see this check.

Results for commit 3cf320d. ± Comparison against base commit aaab17c.

♻️ This comment has been updated with latest results.

@jakirkham
Copy link
Member

Presumably formatting would need to occur with the functions themselves

def print(*args, **kwargs):

def warn(*args, **kwargs):

@jakirkham
Copy link
Member

Should we merge given this improves the status quo?

@jrbourbeau
Copy link
Member Author

Just pushed an update to improve formatting

Copy link

@phobson phobson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

@maxbane
Copy link
Contributor

maxbane commented Oct 8, 2022

See #7129 -- as part of that, I expanded the docstrs and added them to the API docs. Sorry, I hadn't seen this.

@hendrikmakait
Copy link
Member

Superseded by #7129

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants