-
Notifications
You must be signed in to change notification settings - Fork 219
Fix broken @see blocks. #439
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Thanks @MarkDaoust! Before merging, is your intention is to generate the documentation for 0.4.1 that we released last week? If so, the doc must be generated from ther0.4 branch, just want to check if we need to merge this PR in that branch instead.
I was just planning on "eventual consistency", let's not make this more complicated than it needs to be.
Well, looks like it will be more complicated than we were hoping for anyway, because Google's Java style checker did not liked it 😄 (see failing status in GitHub)
what about keeping @see and just passing the straight URL, with no markup nor label?
@see lines try to link the whole line to the name, it tries to lookup these URLs as names in the API and fails:
@see name descriptionhttps://www.tensorflow.org/jvm/api_docs/java/org/tensorflow/DeviceSpec