TestTorch.test_doc should be in TestDocCoverage

[zou3519]

Afaict TestTorch.test_doc tests that certain functions on torch are documented. This is similar to what TestDocCoverage does and it would be great to have all of the documentation tests in one single location.

pytorch/test/test_torch.py

Line 183 in fd3d658

def test_doc(self):

cc @ezyang @zou3519

[ayush-1506]

@zou3519 I'd like to work on this issue, if that's not a problem? Please let me know if I should go ahead.

[ezyang]

Sure! However, I am not sure we are quite clear what exactly should be done here (unless @zou3519 you have a better idea than me). I suggest reading the code and then writing up a short proposal here that we can check over before you start coding.

[ayush-1506]

From what I could understand, the overall objective is to move the test_doc to a member function inside TestDocCoverage (here), since testing for documented functions is the purpose of both these.

At the moment I don't see any caveats, but given that I've merely skimmed over the code, I'd be grateful if someone could verify my understanding and let me know if I've missed something.

cc @ezyang @zou3519

[ayush-1506]

Ping @ezyang @zou3519

[zou3519]

When I opened this issue, I was thinking that we should consolidate all of our docs tests into one test file. i.e., TestTorch.test_doc and TestTorch.test_doc_template should be moved into the same test file as TestDocsCoverage.

The reason for this is to consolidate our docs tests and to perhaps share a blacklist/whitelist between them. Perhaps we should move TestTorch.test_doc and TestTorch.test_doc_template into a new TestCase that is named something like "TestDocstrings" and toss it into test_docs_coverage.py?

[ayush-1506]

Right, that probably makes sense. Please let me know if I should go ahead with this.