Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

tensor.transpose and tensor.T should have "see also" references to each other. #56267

Closed
yoderj opened this issue Apr 16, 2021 · 5 comments
Closed

tensor.transpose and tensor.T should have "see also" references to each other. #56267

yoderj opened this issue Apr 16, 2021 · 5 comments
Labels
module: docs Related to our documentation, both in docs/ and docblocks triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module

Comments

@yoderj
Copy link

yoderj commented Apr 16, 2021 •
edited by pytorch-probot bot

📚 Documentation

https://pytorch.org/docs/stable/generated/torch.transpose.html
and
https://pytorch.org/docs/stable/generated/torch.t.html
should have "see also" references to each other.

I'm willing to make a pull request if the community supports this idea.

cc @brianjo @mruberry
@ezyang
Copy link
Contributor

ezyang commented Apr 16, 2021

SGTM

@ejguan ejguan added module: docs Related to our documentation, both in docs/ and docblocks triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module labels Apr 16, 2021
@yoderj
Copy link
Author

yoderj commented Apr 27, 2021

Just an update: This is still on my radar. I've done some preliminary reading of the source code for PyTorch and I think I have an idea what the edits I will make will be. I expect to make the edits some time in the next two weeks.

@pytorch pytorch deleted a comment from ezyang Apr 27, 2021
@aflah02
Copy link
Contributor

aflah02 commented May 30, 2021

@yoderj Are you still working on this?

@mruberry
Copy link
Collaborator

@aflah02 You can submit a PR if you like, @aflah02. Our contribution guide doesn't allow "reserving" issues

@aflah02
Copy link
Contributor

aflah02 commented Jun 1, 2021

thanks @mruberry

@SplitInfinity SplitInfinity mentioned this issue Aug 12, 2021
Closed
SplitInfinity pushed a commit that referenced this issue Aug 12, 2021
[docs] Add cross references to torch.transpose and torch.t
a2f21db 
**Summary**
This commit adds a link in the documentation for `torch.transpose` that
directs to `torch.t` and vice versa. These two functions are related and
it is useful for users of one to know about the other.

**Test Plan**
Continuous integration.

**Fixes**
This commit fixes #56267.

[ghstack-poisoned]
SplitInfinity pushed a commit that referenced this issue Aug 12, 2021
Update on "[docs] Add cross references to torch.transpose and `torc…
9666c6c 
…h.t`"

**Summary**
This commit adds a link in the documentation for `torch.transpose` that
directs to `torch.t` and vice versa. These two functions are related and
it is useful for users of one to know about the other.

**Test Plan**
Continuous integration.

**Fixes**
This commit fixes #56267.

[ghstack-poisoned]
SplitInfinity pushed a commit that referenced this issue Aug 12, 2021
[docs] Add cross references to torch.transpose and torch.t
c41c14a 
**Summary**
This commit adds a link in the documentation for `torch.transpose` that
directs to `torch.t` and vice versa. These two functions are related and
it is useful for users of one to know about the other.

**Test Plan**
Continuous integration.

**Fixes**
This commit fixes #56267.

ghstack-source-id: d144b9cd7fbc015d2296fc76cee1869daa69fb14
Pull Request resolved: #63177
alanwaketan pushed a commit that referenced this issue Aug 17, 2021
@alanwaketan
[docs] Add cross references to torch.transpose and torch.t (#63177)
c328ce4 
Summary:
Pull Request resolved: #63177

**Summary**
This commit adds a link in the documentation for `torch.transpose` that
directs to `torch.t` and vice versa. These two functions are related and
it is useful for users of one to know about the other.

**Test Plan**
Continuous integration.

**Fixes**
This commit fixes #56267.

Test Plan: Imported from OSS

Reviewed By: VitalyFedyunin

Differential Revision: D30292654

Pulled By: SplitInfinity

fbshipit-source-id: 8e60cd7a598ff8b4756cb30141399dfe8e118338
@SplitInfinity SplitInfinity mentioned this issue Aug 18, 2021
Closed
SplitInfinity pushed a commit that referenced this issue Aug 18, 2021
[docs] Add "See Also" blocks for torch.t and torch.transpose
5268f45 
**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.

**Fixes**
This commit fixes #56267.

[ghstack-poisoned]
SplitInfinity pushed a commit that referenced this issue Aug 18, 2021
[docs] Add "See Also" blocks for torch.t and torch.transpose
24c424f 
**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.

**Fixes**
This commit fixes #56267.

ghstack-source-id: d451ad4bbc8b6262f490d9972ed8ed002a54f9d2
Pull Request resolved: #63461
SplitInfinity pushed a commit that referenced this issue Aug 18, 2021
Update on "[docs] Add "See Also" blocks for torch.t and `torch.tran…
cc16073 
…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]
SplitInfinity pushed a commit that referenced this issue Aug 18, 2021
[docs] Add "See Also" blocks for torch.t and torch.transpose
59601af 
**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.

**Fixes**
This commit fixes #56267.

ghstack-source-id: 04c2b3fb3fbb8e78de62fb0900bb42bfd96135c6
Pull Request resolved: #63461
SplitInfinity pushed a commit that referenced this issue Sep 8, 2021
Update base for Update on "[docs] Add "See Also" blocks for torch.t…
d959b57 
… and `torch.transpose`"


**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="881" alt="Captura de Pantalla 2021-08-18 a la(s) 12 32 42 p  m" src="https://user-images.githubusercontent.com/4392003/129960706-f508fc6d-0ea0-4fad-8213-4321399f2f5f.png">



**Fixes**
This commit fixes #56267.

[ghstack-poisoned]
SplitInfinity pushed a commit that referenced this issue Sep 8, 2021
Update on "[docs] Add "See Also" blocks for torch.t and `torch.tran…
e88c5f9 
…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="881" alt="Captura de Pantalla 2021-08-18 a la(s) 12 32 42 p  m" src="https://user-images.githubusercontent.com/4392003/129960706-f508fc6d-0ea0-4fad-8213-4321399f2f5f.png">



**Fixes**
This commit fixes #56267.

[ghstack-poisoned]
SplitInfinity pushed a commit that referenced this issue Sep 9, 2021
Update base for Update on "[docs] Add "See Also" blocks for torch.t…
f824f5d 
… and `torch.transpose`"


**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="881" alt="Captura de Pantalla 2021-08-18 a la(s) 12 32 42 p  m" src="https://user-images.githubusercontent.com/4392003/129960706-f508fc6d-0ea0-4fad-8213-4321399f2f5f.png">



**Fixes**
This commit fixes #56267.

Differential Revision: [D30799703](https://our.internmc.facebook.com/intern/diff/D30799703)

[ghstack-poisoned]
SplitInfinity pushed a commit that referenced this issue Sep 9, 2021
Update on "[docs] Add "See Also" blocks for torch.t and `torch.tran…
99e2b26 
…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="881" alt="Captura de Pantalla 2021-08-18 a la(s) 12 32 42 p  m" src="https://user-images.githubusercontent.com/4392003/129960706-f508fc6d-0ea0-4fad-8213-4321399f2f5f.png">



**Fixes**
This commit fixes #56267.

Differential Revision: [D30799703](https://our.internmc.facebook.com/intern/diff/D30799703)

[ghstack-poisoned]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
module: docs Related to our documentation, both in docs/ and docblocks triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@ezyang @yoderj @mruberry @ejguan @aflah02