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

Take the Javadoc warning down a notch #491

Open
kevinb9n opened this issue Mar 8, 2024 · 8 comments · May be fixed by #511
Open

Take the Javadoc warning down a notch #491

kevinb9n opened this issue Mar 8, 2024 · 8 comments · May be fixed by #511
Assignees
Labels
documentation For issues related to user-facing documentation nullness For issues specific to nullness analysis.

Comments

@kevinb9n
Copy link
Collaborator

kevinb9n commented Mar 8, 2024

Currently we have

Warning: These annotations are under development, and any aspect of their naming, locations, or design is subject to change until the JSpecify 1.0 release. Moreover, supporting analysis tools will be tracking the changes on varying schedules. Releasing a library using these annotations in its API is strongly discouraged at this time.

This seems overstated at this point, yes?

@kevinherron
Copy link

I was just about to ask about this. On the repo home page / README you have:

Version 0.3 is relatively safe to depend on in your code. Or you can read a more detailed answer.

But then I read the Javadoc and started to question whether it's time yet.

Is there somewhere I can read about the remaining obstacles to a 1.0 version?

@kevinb9n
Copy link
Collaborator Author

Glad you're interested! You can filter issues by the 1.0 milestone. That should at least trend toward accurate.

However, there is an ambiguity between the jar going 1.0 and the spec going 1.0; there are several minor changes that can happen to the latter without any effect on the former. I'm not sure if we accounted for that in how we apply the milestone to issues.

@kevinb9n kevinb9n added the nullness For issues specific to nullness analysis. label Mar 13, 2024
@kevinb9n kevinb9n added this to the 1.0 milestone Mar 14, 2024
@kevinb9n
Copy link
Collaborator Author

For this issue I set the milestone to 1.0 but it's actually "the sooner the better", doesn't need to wait.

@kevinb9n
Copy link
Collaborator Author

Honestly, what happens if we just remove this warning completely?

@kevinherron
Copy link

Honestly, what happens if we just remove this warning completely?

More users? 🙃

@kevinb9n
Copy link
Collaborator Author

Oh, never mind then. 🤣

@agentgt
Copy link

agentgt commented Mar 14, 2024

That warning btw I have seen cited on reddit and various places and the general outcome seems to be unfavorable inhibition even for library authors like myself.

Anyway I'm for more users 😄

@kevinb9n kevinb9n added the documentation For issues related to user-facing documentation label Mar 27, 2024
@woj-tek
Copy link

woj-tek commented May 10, 2024

So my 3¢: I was just thinking about using nullness annotations and wanting to go with something standard but after reading both readme and wiki I wasn't so sure. Then I looked at milestone for 1.0 which sits at ~50% so from the cursory look it's really hard to figure out if one should adopt it or not.

Alas, it seems that 1.0 is closer than further so it should be OK to adopt it :-)

@netdpb netdpb linked a pull request May 21, 2024 that will close this issue
@netdpb netdpb self-assigned this May 21, 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

Successfully merging a pull request may close this issue.

5 participants