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

Add informative comment on @NullUnmarked injections #97

Open
nimakarimipour opened this issue Nov 18, 2022 · 0 comments
Open

Add informative comment on @NullUnmarked injections #97

nimakarimipour opened this issue Nov 18, 2022 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@nimakarimipour
Copy link
Member

nimakarimipour commented Nov 18, 2022

Is your feature request related to a problem? Please describe.

It is not clear to the programmer why the element is annotated as @NullUnmarkd instead of @Nullable if the impact on downstream dependencies prevented annotator from adding @Nullable.

Describe the solution you'd like

Add informative comments on @NullUnmarked injections describing the impact of the annotated method locally and globally. With the format below as suggested by @msridhar:

// local for errors within the scope of the annotation, //non-local for errors outside annotation scope but within the same module, and //dependent module for errors in dependent modules

Describe alternatives you've considered
None.

Additional context
None.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant