Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for code authors #457

Open
netdpb opened this issue Jan 24, 2024 · 0 comments
Open

Documentation for code authors #457

netdpb opened this issue Jan 24, 2024 · 0 comments
Assignees
Labels
documentation For issues related to user-facing documentation nullness For issues specific to nullness analysis.

Comments

@netdpb
Copy link
Collaborator

netdpb commented Jan 24, 2024

Include advice for whether you should start adding these annotations to your code.

Specific documentation for:

  • Authors whose code has no preexisting nullness annotations
  • Authors whose code has other nullness annotations whose semantics are not enforced by any tool
  • Authors whose code has other nullness annotations whose semantics are enforced by specific tools, including some subset of:
    • FindBugs/SpotBugs
    • NullAway
    • Checker Framework
    • IntelliJ

May include updating https://github.com/jspecify/jspecify/wiki/adoption, or replacing that with one or more documents.

@netdpb netdpb added the documentation For issues related to user-facing documentation label Jan 24, 2024
@netdpb netdpb added this to the 1.0 milestone Jan 24, 2024
@kevinb9n kevinb9n added the nullness For issues specific to nullness analysis. label Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation For issues related to user-facing documentation nullness For issues specific to nullness analysis.
Projects
None yet
Development

No branches or pull requests

3 participants