vsilaev/tascalate-concurrent

Include class names in the documentation when highlighting a method

buko opened this issue · 0 comments

buko commented

A minor issue but... The docs are quite good but there are several places in the documentation where a method is highlighted. For example:

Second, there is an adapter method from:
static Promise from(CompletionStage stage)

It is not immediately clear in which class this method is located. The reader has to scan the surrounding text and spot the sentence:

When discussing Promise interface, it's mandatory to mention the accompanying class Promises

to realize this method is located in Promises.

An easy way to fix this might be to simply include a class name when highlighting a method in the documentation. The best way to fix this would be for method highlights to actually link to javadoc. This way when the user remembers that a method exists but is unsure which class the method is located in she can quickly search the docs and then click through to the javadoc.