typetools / typetools/checker-framework

Document @UIType consequences, and other GUI Effect Checker policies more clearly

Open
#4,698 1 comment 0 reactions 1 assignee View on GitHub

@csgordon is already working on this.

Since Jun 4, 2021.

Dominant language
Java
Stars
1.1k
Forks
440
Avg merge
1d 12h
Merged PRs (30d)
134

Description

There are reports that the documentation for @UIType is unclear with regards to how it interacts with inheritance (inherited by anonymous inner classes, not inherited by named subtypes). Need to audit the docs for the checker and make sure this, and other policies, are both clear and easy to find.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.