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.

Sign up for GitHub

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

Jump to bottom

Audit docs for compiletest directives #130997

Closed
jieyouxu opened this issue Sep 28, 2024 · 1 comment
Closed

Audit docs for compiletest directives #130997

jieyouxu opened this issue Sep 28, 2024 · 1 comment
Assignees
@jieyouxu
Labels
A-compiletest Area: The compiletest test runner A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.

Comments

@jieyouxu
Copy link
Member

Location

compiletest

Summary

There are some compiletest directives that are entirely undocumented. The existing docs are sometimes terse and hard to navigate, and don't describe in sufficient detail what each directive does. We should try to make their docs more comprehensive and complete.
@jieyouxu jieyouxu added A-compiletest Area: The compiletest test runner A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Sep 28, 2024
@jieyouxu jieyouxu self-assigned this Sep 28, 2024
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Sep 28, 2024
@jieyouxu jieyouxu removed the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Sep 28, 2024
@jieyouxu
Copy link
Member Author

jieyouxu commented Oct 9, 2024

@jieyouxu jieyouxu closed this as completed Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jieyouxu jieyouxu

Labels
A-compiletest Area: The compiletest test runner A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.
Projects
compiletest maintenance and improvements
Status: Done
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jieyouxu @rustbot