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.

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

[T.F 2.0 API Docs] Adding to the documentation of tf.math.acos and tf.math.add functions #42496

Merged
merged 4 commits into from
Aug 26, 2020

Conversation

Harsh188
Copy link
Contributor

PR for issue #25802.

This PR is similar to #26017 and #25802. However, neither of them were merged.

I have attempted to add improvements to the documentation for tf.math.acos as well as tf.math.add.
This is my first contribution so please do help me identify and fix any errors I might have made.

Thank you

@google-ml-butler google-ml-butler bot added the size:S CL Change Size: Small label Aug 19, 2020
@gbaned gbaned self-assigned this Aug 19, 2020
@gbaned gbaned added this to Assigned Reviewer in PR Queue via automation Aug 19, 2020
Copy link
Collaborator

@mihaimaruseac mihaimaruseac left a comment

Choose a reason for hiding this comment

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

The base_api documentation is available cross language bindings. Python examples should be inserted in Python documentation only, using testable docstrings to ensure that the examples stay in line with code changes.

https://www.tensorflow.org/community/contribute/docs_ref

PR Queue automation moved this from Assigned Reviewer to Reviewer Requested Changes Aug 19, 2020
@mihaimaruseac
Copy link
Collaborator

See 8582a58 for how to expose to Python and add documentation there, as an example

@Harsh188
Copy link
Contributor Author

The base_api documentation is available cross language bindings. Python examples should be inserted in Python documentation only, using testable docstrings to ensure that the examples stay in line with code changes.

https://www.tensorflow.org/community/contribute/docs_ref

Whoops, I saw your comment on #25802 however I didn't quite understand the significance of the issue. Thank you for clarifying once again.
I will be removing the python examples from the base_api documentation and resubmit for review. I will then open another PR to add documentation to python/ops/math_ops.py.

@Harsh188
Copy link
Contributor Author

Pinging @mihaimaruseac for review.
I'm assuming that along with adding examples to python/ops/math_ops.py, I will similarly have to do the same to core/ops/math_ops.cc.

@Harsh188
Copy link
Contributor Author

Created a PR #42619 to address changes to the python documentation.

PR Queue automation moved this from Reviewer Requested Changes to Approved by Reviewer Aug 24, 2020
@google-ml-butler google-ml-butler bot added kokoro:force-run Tests on submitted change ready to pull PR ready for merge process labels Aug 24, 2020
@kokoro-team kokoro-team removed the kokoro:force-run Tests on submitted change label Aug 24, 2020
@tensorflow-copybara tensorflow-copybara merged commit 43c9523 into tensorflow:master Aug 26, 2020
PR Queue automation moved this from Approved by Reviewer to Merged Aug 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes ready to pull PR ready for merge process size:S CL Change Size: Small
Projects
PR Queue
  
Merged
Development

Successfully merging this pull request may close these issues.

None yet

6 participants