Skip to content

Add some missing docs for tensor methods and attributes, new unittest to enforce tensors.rst no longer miss anything#16057

Closed
zasdfgbnm wants to merge 23 commits intopytorch:masterfrom
zasdfgbnm:doc-cov-tensors
Closed

Add some missing docs for tensor methods and attributes, new unittest to enforce tensors.rst no longer miss anything#16057
zasdfgbnm wants to merge 23 commits intopytorch:masterfrom
zasdfgbnm:doc-cov-tensors

Conversation

@zasdfgbnm
Copy link
Copy Markdown
Collaborator

@zasdfgbnm zasdfgbnm commented Jan 16, 2019

This depend on #16039

This prevent people (reviewer, PR author) from forgetting adding things to tensors.rst.

When something new is added to _tensor_doc.py or tensor.py but intentionally not in tensors.rst, people should manually whitelist it in test_docs_coverage.py.

@zasdfgbnm
Copy link
Copy Markdown
Collaborator Author

@pytorchbot rebase this please

@ezyang
Copy link
Copy Markdown
Contributor

ezyang commented Mar 26, 2019

Looks like there are still some missing docs?

@zasdfgbnm
Copy link
Copy Markdown
Collaborator Author

@ezyang Let me look into it.

@zasdfgbnm
Copy link
Copy Markdown
Collaborator Author

@ezyang I just updated the test to make it pass. The update is mainly on improving error messages, as well as manually whitelist all nn functionals mistakely binded to torch.*, so this test now serves as a list for #16322

@ezyang ezyang self-assigned this Mar 26, 2019
Copy link
Copy Markdown
Contributor

@facebook-github-bot facebook-github-bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ezyang is landing this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

@zasdfgbnm zasdfgbnm deleted the doc-cov-tensors branch March 27, 2019 01:11
@facebook-github-bot
Copy link
Copy Markdown
Contributor

@ezyang merged this pull request in 2ba41c5.

laurentdupin pushed a commit to laurentdupin/pytorch that referenced this pull request Apr 24, 2026
… to enforce tensors.rst no longer miss anything (pytorch#16057)

Summary:
This depend on pytorch#16039

This prevent people (reviewer, PR author) from forgetting adding things to `tensors.rst`.

When something new is added to `_tensor_doc.py` or `tensor.py` but intentionally not in `tensors.rst`, people should manually whitelist it in `test_docs_coverage.py`.
Pull Request resolved: pytorch#16057

Differential Revision: D14619550

Pulled By: ezyang

fbshipit-source-id: e1c6dd6761142e2e48ec499e118df399e3949fcc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants