<p dir="auto">Thank you for submitting a TensorFlow documentation issue. Per our GitHub<br>
policy, we only address code/doc bugs, performance issues, feature requests, and<br>
build/installation issues on GitHub.</p>
<p dir="auto">The TensorFlow docs are open source! To get involved, read the documentation<br>
contributor guide: <a href="https://www.tensorflow.org/community/contribute/docs" rel="nofollow">https://www.tensorflow.org/community/contribute/docs</a></p>
<h2 dir="auto">URL(s) with the issue:</h2>
<p dir="auto">Please provide a link to the documentation entry, for example:<br>
<a href="https://www.tensorflow.org/versions/r2.0/api_docs/python/tf/MyMethod" rel="nofollow">https://www.tensorflow.org/versions/r2.0/api_docs/python/tf/MyMethod</a></p>
<h2 dir="auto">Description of issue (what needs changing):</h2>
<h3 dir="auto">Clear description</h3>
<p dir="auto">For example, why should someone use this method? How is it useful?</p>
<h3 dir="auto">Correct links</h3>
<p dir="auto">Is the link to the source code correct?</p>
<h3 dir="auto">Parameters defined</h3>
<p dir="auto">Are all parameters defined and formatted correctly?</p>
<h3 dir="auto">Returns defined</h3>
<p dir="auto">Are return values defined?</p>
<h3 dir="auto">Raises listed and defined</h3>
<p dir="auto">Are the errors defined? For example,<br>
<a href="https://www.tensorflow.org/versions/r2.0/api_docs/python/tf/feature_column/categorical_column_with_vocabulary_file#raises" rel="nofollow">https://www.tensorflow.org/versions/r2.0/api_docs/python/tf/feature_column/categorical_column_with_vocabulary_file#raises</a></p>
<h3 dir="auto">Usage example</h3>
<p dir="auto">Is there a usage example?</p>
<h3 dir="auto">Request visuals, if applicable</h3>
<p dir="auto">Are there currently visuals? If not, will it clarify the content?</p>
<h3 dir="auto">Submit a pull request?</h3>
<p dir="auto">Are you planning to also submit a pull request to fix the issue? See the docs<br>
contributor guide: <a href="https://www.tensorflow.org/community/contribute/docs" rel="nofollow">https://www.tensorflow.org/community/contribute/docs</a> and the<br>
docs style guide: <a href="https://www.tensorflow.org/community/contribute/docs_style" rel="nofollow">https://www.tensorflow.org/community/contribute/docs_style</a></p>
<p dir="auto">Thank you for submitting a TensorFlow documentation issue. Per our GitHub<br>
policy, we only address code/doc bugs, performance issues, feature requests, and<br>
build/installation issues on GitHub.</p>
<p dir="auto">The TensorFlow docs are open source! To get involved, read the documentation<br>
contributor guide: <a href="https://www.tensorflow.org/community/contribute/docs" rel="nofollow">https://www.tensorflow.org/community/contribute/docs</a></p>
<h2 dir="auto">URL(s) with the issue:</h2>
<p dir="auto">Please provide a link to the documentation entry, for example:<br>
<a href="https://www.tensorflow.org/versions/r2.0/api_docs/python/tf/io/write_file" rel="nofollow">https://www.tensorflow.org/versions/r2.0/api_docs/python/tf/io/write_file</a></p>
<h2 dir="auto">Description of issue (what needs changing):</h2>
<h3 dir="auto">Clear description</h3>
<p dir="auto">The description does not recommend at all in any way when and when not to use this symbol.</p>
<h3 dir="auto">Correct links</h3>
<p dir="auto">Yes</p>
<h3 dir="auto">Parameters defined</h3>
<p dir="auto">Yes</p>
<h3 dir="auto">Returns defined</h3>
<p dir="auto">Yes</p>
<h3 dir="auto">Raises listed and defined</h3>
<p dir="auto">The returned objects are not well defined and therefore not correct, complete and appropriately formatted</p>
<h3 dir="auto">Usage example</h3>
<p dir="auto">Yes</p>
<h3 dir="auto">Request visuals, if applicable</h3>
<p dir="auto">No single visual included in the symbol’s description. In some instances it will definitely clarify the content being presented.</p>
<h3 dir="auto">Submit a pull request?</h3>
<p dir="auto">Are you planning to also submit a pull request to fix the issue? See the docs<br>
contributor guide: <a href="https://www.tensorflow.org/community/contribute/docs" rel="nofollow">https://www.tensorflow.org/community/contribute/docs</a> and the<br>
docs style guide: <a href="https://www.tensorflow.org/community/contribute/docs_style" rel="nofollow">https://www.tensorflow.org/community/contribute/docs_style</a></p>