Skip to content

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

Closed
jrbourbeau wants to merge 2 commits into
dask:mainfrom
jrbourbeau:print-warn-api
Closed

Add distributed.print and distributed.warn to API docs#7113
jrbourbeau wants to merge 2 commits into
dask:mainfrom
jrbourbeau:print-warn-api

Conversation

@jrbourbeau

Copy link
Copy Markdown
Member

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

@phobson

phobson commented Oct 5, 2022

Copy link
Copy Markdown

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

image

@github-actions

github-actions Bot commented Oct 5, 2022

Copy link
Copy Markdown
Contributor

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
Copy Markdown
Member

Presumably formatting would need to occur with the functions themselves

def print(*args, **kwargs):

def warn(*args, **kwargs):

@jakirkham

Copy link
Copy Markdown
Member

Should we merge given this improves the status quo?

@jrbourbeau

Copy link
Copy Markdown
Member Author

Just pushed an update to improve formatting

@phobson phobson left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

image

@maxbane

maxbane commented Oct 8, 2022

Copy link
Copy Markdown
Contributor

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
Copy Markdown
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