Skip to content

Commit

Permalink
Drop text about 'legacy methods' From RestrictedApi methods
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 621319804
  • Loading branch information
cushon authored and Error Prone Team committed Apr 2, 2024
1 parent 0c12a77 commit 4ce508b
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/bugpattern/RestrictedApi.md
@@ -1,2 +1,11 @@
Calls to APIs marked @RestrictedApi are prohibited without a corresponding
Calls to APIs marked `@RestrictedApi` are prohibited without a corresponding
allowlist annotation.

The intended use-case for `@RestrictedApi` is to restrict calls to annotated
methods so that each usage of those APIs must be reviewed separately. For
example, an API might lead to security bugs unless the programmer uses it
correctly.

See the
[javadoc for `@RestrictedApi`](https://errorprone.info/api/latest/com/google/errorprone/annotations/RestrictedApi.html)
for more details.

0 comments on commit 4ce508b

Please sign in to comment.