Document ForwardingAudience
Open
Nobody has claimed this yet.
dev guide
good first issue
project: Adventure
- Dominant language
- MDX
- Stars
- 73
- Forks
- 280
- Avg merge
- 20h 52m
- Merged PRs (30d)
- 4
Description
Points to cover
- extend
.Single - how only the terminal methods are overridden
- Use in cross-platform plugins
Example use cases
public class GameTeam implements ForwardingAudience {
private final List<GamePlayer> players = new ArrayList<>();
// ....
@Override
public @NonNull Iterable<? extends GamePlayer> audiences() {
return this.players;
}
}
Migrated from https://github.com/KyoriPowered/adventure-docs/issues/8
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start from the ForwardingAudience entry point and review the existing documentation structure for the relevant Adventure API. Document how it extends .Single, why only terminal methods are overridden, and how cross-platform plugins can use it, including the GameTeam example shown in the issue.
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
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100