Skip to content

Commit

Permalink
Update on "[docs] Add "See Also" blocks for torch.t and `torch.tran…
Browse files Browse the repository at this point in the history
…spose`"


**Summary**
PR 63177 added "see also" cross-references to `torch.t` and
`torch.transpose`. However, it did so in the form of simple links
preceded by the phrase "See also". A comment on the aforementioned PR
pointed out the RST has special syntax to render a "See Also" box that
is more noticeable. This commit converts the "see also" sentences for
`torch.t` and `torch.transpose` to boxes.

**Test Plan**
Continuous integration.

*Before*

<img width="931" alt="Captura de Pantalla 2021-08-18 a la(s) 10 47 21 a  m" src="https://user-images.githubusercontent.com/4392003/129948036-a92204be-7175-456e-ae25-df41333579ce.png">

*After*
<img width="885" alt="Captura de Pantalla 2021-08-18 a la(s) 10 46 38 a  m" src="https://user-images.githubusercontent.com/4392003/129948051-d3d98dd0-b727-40de-afe5-86158f887a81.png">


**Fixes**
This commit fixes #56267.

[ghstack-poisoned]
  • Loading branch information
Meghan Lele committed Aug 18, 2021
1 parent 5268f45 commit cc16073
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions torch/_torch_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -9337,7 +9337,7 @@ def merge_dicts(*dicts):
.. seealso::
:func:`torch.transpose`.
:func:`torch.transpose` for a function that can swap arbitrary dimensions of any tensor.
Args:
{input}
Expand Down Expand Up @@ -9708,7 +9708,7 @@ def merge_dicts(*dicts):
.. seealso::
:func:`torch.t`.
:func:`torch.t` for a function that transposes tensors with <=2 dimensions.
Args:
{input}
Expand Down

0 comments on commit cc16073

Please sign in to comment.