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

fix unexpected indentation in Client.cancel docstring #7694

Merged
merged 1 commit into from
Mar 22, 2023

Conversation

graingert
Copy link
Member

@graingert graingert commented Mar 22, 2023

running sphinx with -W fails with:

site-packages/distributed/client.py:docstring of distributed.client.Client.cancel:9:Unexpected indentation.

and results in ugly output https://docs.dask.org/en/latest/futures.html#distributed.Client.cancel

before:
image

after:
image

  • Tests added / passed
  • Passes pre-commit run --all-files

@graingert graingert marked this pull request as ready for review March 22, 2023 12:19
@graingert graingert requested a review from fjetter as a code owner March 22, 2023 12:19
@github-actions
Copy link
Contributor

Unit Test Results

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

     26 files  ±0       26 suites  ±0   1h 16m 28s ⏱️ -15s
3 143 tests ±0  2 929 ✔️ ±0  211 💤  - 1  2 +1    1 🔥 ±0 
6 424 runs  ±0  5 623 ✔️ ±0  777 💤  - 1  2 +1  22 🔥 ±0 

For more details on these failures and errors, see this check.

Results for commit c2b603d. ± Comparison against base commit 6fb7f0e.

@graingert graingert force-pushed the unexpected-indentation branch 2 times, most recently from b133eff to 47d6a76 Compare March 22, 2023 13:45
@graingert
Copy link
Member Author

there are more warnings that sphinx prints, and I've fixed the rest of them here #7697 (and enabled warning checking) but this is the only warning that has a visual impact

Copy link
Member

@jrbourbeau jrbourbeau left a comment

Choose a reason for hiding this comment

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

Thanks @graingert!

@jrbourbeau jrbourbeau merged commit 9bd90c0 into dask:main Mar 22, 2023
@graingert graingert deleted the unexpected-indentation branch March 22, 2023 15:33
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.

2 participants