diff options
| author | Ozan Çağlayan <ozancag@gmail.com> | 2017-11-09 14:12:29 +0100 |
|---|---|---|
| committer | Soumith Chintala <soumith@gmail.com> | 2017-11-09 08:12:29 -0500 |
| commit | dd6d04ddf243964700670c38e1a5ef4f50dc34cf (patch) | |
| tree | 434802cb1a849285e2348bef85b6fda6c4dbfa13 /torch/_utils.py | |
| parent | 9d4c2d743ba8b69fbaf151b4eaa52f9082c55491 (diff) | |
| download | pytorch-dd6d04ddf243964700670c38e1a5ef4f50dc34cf.tar.gz pytorch-dd6d04ddf243964700670c38e1a5ef4f50dc34cf.tar.bz2 pytorch-dd6d04ddf243964700670c38e1a5ef4f50dc34cf.zip | |
doc: Normalize all true/false in docstrings to ``True|False`` (#3593)
* doc: Normalize all true/false in docstrings to ``True|False``
This makes them more apparent in the documentation.
* doc: fix flake8
Diffstat (limited to 'torch/_utils.py')
| -rw-r--r-- | torch/_utils.py | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/torch/_utils.py b/torch/_utils.py index 9ed02a09f3..45ddbb1534 100644 --- a/torch/_utils.py +++ b/torch/_utils.py @@ -12,7 +12,7 @@ def _type(self, new_type=None, async=False): Args: new_type (type or string): The desired type - async (bool): If True, and the source is in pinned memory and + async (bool): If ``True``, and the source is in pinned memory and destination is on the GPU or vice versa, the copy is performed asynchronously with respect to the host. Otherwise, the argument has no effect. @@ -46,7 +46,7 @@ def _cuda(self, device=None, async=False): Args: device (int): The destination GPU id. Defaults to the current device. - async (bool): If True and the source is in pinned memory, the copy will + async (bool): If ``True`` and the source is in pinned memory, the copy will be asynchronous with respect to the host. Otherwise, the argument has no effect. """ |