1--- 2name: Documentation Issue 3about: Use this template for documentation related issues 4labels: 'type:docs' 5 6--- 7 8 9Thank you for submitting a TensorFlow documentation issue. Per our GitHub 10policy, we only address code/doc bugs, performance issues, feature requests, and 11build/installation issues on GitHub. 12 13The TensorFlow docs are open source! To get involved, read the documentation 14contributor guide: https://www.tensorflow.org/community/contribute/docs 15 16## URL(s) with the issue: 17 18Please provide a link to the documentation entry, for example: 19https://www.tensorflow.org/versions/r2.0/api_docs/python/tf/MyMethod 20 21## Description of issue (what needs changing): 22 23### Clear description 24 25For example, why should someone use this method? How is it useful? 26 27### Correct links 28 29Is the link to the source code correct? 30 31### Parameters defined 32 33Are all parameters defined and formatted correctly? 34 35### Returns defined 36 37Are return values defined? 38 39### Raises listed and defined 40 41Are the errors defined? For example, 42https://www.tensorflow.org/versions/r2.0/api_docs/python/tf/feature_column/categorical_column_with_vocabulary_file#raises 43 44### Usage example 45 46Is there a usage example? 47 48See the API guide: https://www.tensorflow.org/community/contribute/docs_ref 49on how to write testable usage examples. 50 51### Request visuals, if applicable 52 53Are there currently visuals? If not, will it clarify the content? 54 55### Submit a pull request? 56 57Are you planning to also submit a pull request to fix the issue? See the docs 58contributor guide: https://www.tensorflow.org/community/contribute/docs, 59docs API guide: https://www.tensorflow.org/community/contribute/docs_ref and the 60docs style guide: https://www.tensorflow.org/community/contribute/docs_style 61