KEMBAR78
fix `torch.futures` docstring examples by pmeier · Pull Request #61029 · pytorch/pytorch · GitHub
Skip to content

Conversation

@pmeier
Copy link
Collaborator

@pmeier pmeier commented Jun 30, 2021

Trying to run the doctests for the complete documentation hangs if it reaches the examples of torch.futures. It turns out to be only syntax errors, which are normally just reported. My guess is that doctest probably doesn't work well for failures within async stuff.

Anyway, while debugging this, I fixed the syntax.

@facebook-github-bot
Copy link
Contributor

facebook-github-bot commented Jun 30, 2021

💊 CI failures summary and remediations

As of commit f5db4e8 (more details on the Dr. CI page and at hud.pytorch.org/pr/61029):


None of the CI failures appear to be your fault 💚



🚧 2 fixed upstream failures:

These were probably caused by upstream breakages that were already fixed.

Please rebase on the viable/strict branch (expand for instructions)

If your commit is older than viable/strict, run these commands:

git fetch https://github.com/pytorch/pytorch viable/strict
git rebase FETCH_HEAD

Preview docs built from this PR

This comment was automatically generated by Dr. CI (expand for details).Follow this link to opt-out of these comments for your Pull Requests.

Please report bugs/suggestions to the (internal) Dr. CI Users group.

Click here to manually regenerate this comment.

@pmeier pmeier requested review from mrshenli and mruberry June 30, 2021 07:42
@mruberry
Copy link
Collaborator

@mrshenli -- you OK to review this?

@codecov
Copy link

codecov bot commented Jun 30, 2021

Codecov Report

Merging #61029 (c7acf85) into master (001ff3a) will decrease coverage by 4.87%.
The diff coverage is 89.25%.

❗ Current head c7acf85 differs from pull request most recent head f5db4e8. Consider uploading reports for the commit f5db4e8 to get more accurate results

@@            Coverage Diff             @@
##           master   #61029      +/-   ##
==========================================
- Coverage   80.60%   75.73%   -4.88%     
==========================================
  Files        1879     2062     +183     
  Lines      202892   209335    +6443     
==========================================
- Hits       163543   158534    -5009     
- Misses      39349    50801   +11452     

Copy link
Contributor

@mrshenli mrshenli left a comment

Choose a reason for hiding this comment

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

Doc fixes LGTM. Thanks for fixing!

Did you get a chance to check that the result renders correctly in our doc page?

@facebook-github-bot
Copy link
Contributor

@mrshenli has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

@pmeier
Copy link
Collaborator Author

pmeier commented Jul 7, 2021

@mrshenli

Did you get a chance to check that the result renders correctly in our doc page?

You can find the rendered version here.

@facebook-github-bot
Copy link
Contributor

@mrshenli has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

@facebook-github-bot
Copy link
Contributor

@mrshenli merged this pull request in 1262b2c.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants