java icon indicating copy to clipboard operation
java copied to clipboard

Fix broken @see blocks.

Open MarkDaoust opened this issue 3 years ago • 3 comments
trafficstars

@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

MarkDaoust avatar Apr 04 '22 17:04 MarkDaoust

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.

karllessard avatar Apr 04 '22 17:04 karllessard

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

MarkDaoust avatar Apr 04 '22 17:04 MarkDaoust

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?

karllessard avatar Apr 04 '22 23:04 karllessard