-
Notifications
You must be signed in to change notification settings - Fork 58
Add type system docs 2025h2 goal #314
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
Open
BoxyUwU
wants to merge
1
commit into
rust-lang:main
Choose a base branch
from
BoxyUwU:typesystem-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||||
---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,39 @@ | ||||||||
# Type System Documentation | ||||||||
|
||||||||
| Metadata | | | ||||||||
|:-----------------|----------| | ||||||||
| Point of contact | @BoxyUwU | | ||||||||
| Teams | | | ||||||||
| Task owners | @BoxyUwU | | ||||||||
| Status | Proposed | | ||||||||
| Tracking issue | | | ||||||||
| Zulip channel | N/A | | ||||||||
|
||||||||
## Summary | ||||||||
|
||||||||
Improve documentation of type system components to aide in types team onboarding and communication about changes to the type system . | ||||||||
|
||||||||
## Motivation & Status Quo | ||||||||
|
||||||||
The type system is a very complex and critical component of the compiler. It is currently lacking in documentation, and the documentation that *does* exist is often inadequate for gaining a thorough understanding of a given part of the type system (or simply outdated as it was written many years ago). | ||||||||
|
||||||||
The lack of documentation makes onboarding difficult for new contributors and require a lot of energy from experienced contributors who are now responsible for explaining everything from scratch themselves. A similar problem also occurs when reviewing changes to the type system, as there is no documentation it can be difficult to bring everything back into cache and be confident that the subtleties of the area being changed have all been taken into account. | ||||||||
|
||||||||
### The next 6 months | ||||||||
|
||||||||
- Compile a list of type system concepts then compare that against the in-compiler documentation and the rustc-dev-guide's type system chapter to find weak points in our documentation. | ||||||||
- Document existing known weak points: | ||||||||
- How const generic arguments are type checked | ||||||||
- The design of the new solver and how/why it differs from the old solver | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nice |
||||||||
|
||||||||
### The "shiny future" we are working towards | ||||||||
|
||||||||
All type system components should be thoroughly documented. Contributors should not find themselves in a position where knowledge of the type system is *only* attainable by speaking with types team members instead of having readily available documentation to read. | ||||||||
|
||||||||
## Ownership and team asks | ||||||||
|
||||||||
| Task | Owner(s) or team(s) | Notes | | ||||||||
|------------------------------|---------------------|-------| | ||||||||
| Triage Analysis Chapter | @BoxyUwU | | | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||
| Const Generics Documentation | @BoxyUwU | | | ||||||||
| New Solver Documentation | @BoxyUwU @lcnr | | |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will this be made available somewhere? Either posted on the types team repo? o perhaps a tracking issue? or open up (best) individual tracking issues? I think we should do that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would expect to put a summarized list in the project goal tracking issue, and then also have associated issues in the dev guide repo tracking each individual topic/area 🤔 Having stuff in the types repo may make sense too though