google / google/error-prone

Update docs for CheckReturnValue

Open
#5,419 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
7.2k
Forks
820
Avg merge
5h 9m
Merged PRs (30d)
50

Description

The "How to tell Error Prone which methods to check" section doesn't seem to reflect the changes made in https://github.com/google/error-prone/pull/435.

It also would be better to expand the "Ignored contexts" section to fully reflect the following:

https://github.com/google/error-prone/blob/b1631feee1b2cd2a2bb420a4ed712ebf36920041/check_api/src/main/java/com/google/errorprone/matchers/Matchers.java#L1330-L1353

See https://errorprone.info/bugpattern/CheckReturnValue

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.