jspecify / jspecify/jspecify

Put appropriate "(Why?)" links in the user guide as we did for the javadoc

Open Beginner friendly
#364 9 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Java
Stars
1.1k
Forks
43
Avg merge
9m
Merged PRs (30d)
13

Description

Please spent a short paragraph in Nullness User Guide why I have to write
<T extends @Nullable Object> T firstOrDefault(List<T> list, T defaultValue) {
instead of
<@Nullable T> T firstOrDefault(List<T> list, T defaultValue) {
and / or provide a comprehensible explanation what latter actually means.

(Out of scope: is it possible to pass Consumer<@Nullable String> c to void process(Consumer<String> s))

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Nullness User Guide and inspect how the javadoc uses “(Why?)” links. Add a short, comprehensible explanation of why the two generic nullness forms differ, or what the latter means, while leaving the Consumer question out of scope; the issue is done when the relevant guide section contains that explanation and/or link.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
64/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.