FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Fix broken @see blocks. by MarkDaoust · Pull Request #439 · tensorflow/java · GitHub

/ java Public

Fix broken @see blocks. - #439

Open
MarkDaoust wants to merge 1 commit into
tensorflow:masterfrom
MarkDaoust:fix-links
ConversationCommits (1)ChecksFiles changed
Open

Fix broken @see blocks.#439
MarkDaoust wants to merge 1 commit into
tensorflow:masterfrom
MarkDaoust:fix-links

Conversation

MarkDaoust commented Apr 4, 2022

Copy link
Copy Markdown
Member

@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 description

https://www.tensorflow.org/jvm/api_docs/java/org/tensorflow/DeviceSpec

Craigacp approved these changes Apr 4, 2022
View reviewed changes

Craigacp left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM

karllessard commented Apr 4, 2022

Copy link
Copy Markdown
Collaborator

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.

MarkDaoust commented Apr 4, 2022

Copy link
Copy Markdown
Member Author

I was just planning on "eventual consistency", let's not make this more complicated than it needs to be.

karllessard commented Apr 4, 2022

Copy link
Copy Markdown
Collaborator

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?

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Craigacp Craigacp approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL