Document that Tracer#extract can return null

opentracing / opentracing-java

OpenTracing API for Java. 🛑 This library is DEPRECATED! https://github.com/opentracing/specification/issues/163

http://opentracing.io

Apache License 2.0

1.68k stars 344 forks source link

Document that Tracer#extract can return null #283

Closed realark closed 6 years ago

realark commented 6 years ago

See https://github.com/opentracing/opentracing-java/issues/168

https://github.com/opentracing/opentracing-java/pull/203

There are two proposed changes in the above issue:

Documenting that Tracer#extract can return null (many tracer impls are already doing this)
Adding @Nullable annotation to extract to assist static checkers

This PR only addresses the doc change. The annotation will be proposed in a separate PR.

coveralls commented 6 years ago

Coverage remained the same at 73.368% when pulling 68d5b303a5305b676810137daca10834d87b419b on realark:ark/nullable-tracer-extract into 4a04d986107c016062235f0b4ca04510b7f68b13 on opentracing:master.