[GraphBolt][Doc] Fix read_async doc display issue. (dmlc#7741)

mfbalin · Aug 25, 2024 · ffe3bb2 · ffe3bb2
1 parent d68029a
commit ffe3bb2
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/python/dgl/graphbolt/impl/cpu_cached_feature.py b/python/dgl/graphbolt/impl/cpu_cached_feature.py
@@ -81,7 +81,7 @@ def read_async(self, ids: torch.Tensor):
         -------
         A generator object.
             The returned generator object returns a future on
-            ``read_async_num_stages(ids.device)``th invocation. The return result
+            ``read_async_num_stages(ids.device)``\ th invocation. The return result
             can be accessed by calling ``.wait()``. on the returned future object.
             It is undefined behavior to call ``.wait()`` more than once.
 

diff --git a/python/dgl/graphbolt/impl/gpu_cached_feature.py b/python/dgl/graphbolt/impl/gpu_cached_feature.py
@@ -113,7 +113,7 @@ def read_async(self, ids: torch.Tensor):
         -------
         A generator object.
             The returned generator object returns a future on
-            ``read_async_num_stages(ids.device)``th invocation. The return result
+            ``read_async_num_stages(ids.device)``\ th invocation. The return result
             can be accessed by calling ``.wait()``. on the returned future object.
             It is undefined behavior to call ``.wait()`` more than once.
 

diff --git a/python/dgl/graphbolt/impl/torch_based_feature_store.py b/python/dgl/graphbolt/impl/torch_based_feature_store.py
@@ -151,7 +151,7 @@ def read_async(self, ids: torch.Tensor):
         -------
         A generator object.
             The returned generator object returns a future on
-            ``read_async_num_stages(ids.device)``th invocation. The return result
+            ``read_async_num_stages(ids.device)``\ th invocation. The return result
             can be accessed by calling ``.wait()``. on the returned future object.
             It is undefined behavior to call ``.wait()`` more than once.
 
@@ -434,7 +434,7 @@ def read_async(self, ids: torch.Tensor):
         -------
         A generator object.
             The returned generator object returns a future on
-            ``read_async_num_stages(ids.device)``th invocation. The return result
+            ``read_async_num_stages(ids.device)``\ th invocation. The return result
             can be accessed by calling ``.wait()``. on the returned future object.
             It is undefined behavior to call ``.wait()`` more than once.