update docstring examples of torch.testing.assert_close
#60163
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Changes to the default error message in case of mismatching values need to be reflected in the examples given in the docstring. Normally this should be enforced by a [`doctest`](https://docs.python.org/3/library/doctest.html). @mruberry do you know why we don't have such a check? [ghstack-poisoned]
This was referenced Jun 17, 2021
💊 CI failures summary and remediationsAs of commit 56c045d (more details on the Dr. CI page and at hud.pytorch.org/pr/60163): 💚 💚 Looks good so far! There are no failures yet. 💚 💚 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. |
This was referenced Jun 17, 2021
pmeier
added a commit
that referenced
this pull request
Jun 17, 2021
Changes to the default error message in case of mismatching values need to be reflected in the examples given in the docstring. Normally this should be enforced by a [`doctest`](https://docs.python.org/3/library/doctest.html). @mruberry do you know why we don't have such a check? ghstack-source-id: 89b43a5 Pull Request resolved: #60163
Changes to the default error message in case of mismatching values need to be reflected in the examples given in the docstring. Normally this should be enforced by a [`doctest`](https://docs.python.org/3/library/doctest.html). @mruberry do you know why we don't have such a check? [ghstack-poisoned]
pmeier
added
the
module: testing
Changes to the default error message in case of mismatching values need to be reflected in the examples given in the docstring. Normally this should be enforced by a [`doctest`](https://docs.python.org/3/library/doctest.html). @mruberry do you know why we don't have such a check? [ghstack-poisoned]
Changes to the default error message in case of mismatching values need to be reflected in the examples given in the docstring. Normally this should be enforced by a [`doctest`](https://docs.python.org/3/library/doctest.html). @mruberry do you know why we don't have such a check? [ghstack-poisoned]
Changes to the default error message in case of mismatching values need to be reflected in the examples given in the docstring. Normally this should be enforced by a [`doctest`](https://docs.python.org/3/library/doctest.html). @mruberry do you know why we don't have such a check? [ghstack-poisoned]
Changes to the default error message in case of mismatching values need to be reflected in the examples given in the docstring. Normally this should be enforced by a [`doctest`](https://docs.python.org/3/library/doctest.html). @mruberry do you know why we don't have such a check? [ghstack-poisoned]
mruberry
approved these changes
Jun 24, 2021
There was a problem hiding this comment.
Neat.
We do have some doc testing, but I'm never sure how it works. @peterbell10 just started running some examples as tests, maybe check with him?
Changes to the default error message in case of mismatching values need to be reflected in the examples given in the docstring. Normally this should be enforced by a [`doctest`](https://docs.python.org/3/library/doctest.html). @mruberry do you know why we don't have such a check? [ghstack-poisoned]
This was referenced Jun 24, 2021
Changes to the default error message in case of mismatching values need to be reflected in the examples given in the docstring. Normally this should be enforced by a [`doctest`](https://docs.python.org/3/library/doctest.html). @mruberry do you know why we don't have such a check? [ghstack-poisoned]
|
I've added a doctest for |
Changes to the default error message in case of mismatching values need to be reflected in the examples given in the docstring. Normally this should be enforced by a [`doctest`](https://docs.python.org/3/library/doctest.html). @mruberry do you know why we don't have such a check? [ghstack-poisoned]
|
@mruberry has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Stack from ghstack:
msgintorch.testing.assert_close#60254 tests for diagnostics in callablemsgintorch.testing.assert_closetorch.testing.assert_close#60163 update docstring examples oftorch.testing.assert_closetorch.testing.assert_closein case of mismatching values #60091 Improve error messages oftorch.testing.assert_closein case of mismatching valuesChanges to the default error message in case of mismatching values need to be reflected in the examples given in the docstring. Normally this should be enforced by a
doctest. @mruberry do you know why we don't have such a check?Differential Revision: D29556353