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.

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

Remove details about chalk and point to Chalk Book instead. #679

Merged
merged 5 commits into from
Apr 25, 2020

Conversation

crlf0710
Copy link
Member

Now that these contents have been moved to the Chalk Book, this PR remove these contents and point to that instead.

@tshepang
Copy link
Member

wow, wasn't aware there's so much chalk doc here

Copy link
Member

@mark-i-m mark-i-m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @crlf0710! This is cleanup that has been on my TODO list for a long time.

I have two concerns:

  • I don't know if there is any non-chalk-specific knowledge in these chapters that we should condense and keep in some form
  • I don't know if any of the chalk-rustc integration content is still relevant. I understood it to be all out of date. So perhaps we should just mention that there is some experimental effort to do integration and leave it at that?

I would really appreciate some guidance from @rust-lang/wg-traits on this...

src/appendix/code-index.md Outdated Show resolved Hide resolved
src/appendix/glossary.md Outdated Show resolved Hide resolved
src/appendix/glossary.md Outdated Show resolved Hide resolved
src/traits/associated-types.md Show resolved Hide resolved
src/traits/chalk.md Outdated Show resolved Hide resolved
src/traits/chalk.md Show resolved Hide resolved
src/traits/lowering-module.md Show resolved Hide resolved
src/SUMMARY.md Outdated
- [An Overview of Chalk](./traits/chalk-overview.md)
- [Bibliography](./traits/bibliography.md)
- [Chalk-based trait solving](./traits/chalk.md)
- [Region constraints](./traits/regions.md)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would just remove this subchapter and delete ./traits/region.md

@detrumi
Copy link
Member

detrumi commented Apr 19, 2020

I don't know if there is any non-chalk-specific knowledge in these chapters that we should condense and keep in some form

Let's see, going over the sections:

  • Lowering to logic: This has a nice short introduction which won't change much (since it's based on a blog post, and talks about the general ideas), so the introduction can stay. And the "goals and clauses" subsection seems relevant to rustc too
  • Canonical queries: this talks about trait queries in rustc, so this should stay here (and possibly not even add it to the chalk book)
  • SLG solver: this talks about chalk internals, so that can go to the chalk book
  • chalk overview: this can just be replaced by a link to the chalk book

I don't know if any of the chalk-rustc integration content is still relevant. I understood it to be all out of date. So perhaps we should just mention that there is some experimental effort to do integration and leave it at that?

The WF section states "The new-style WF checking has not been implemented in rustc yet", so I think there isn't much. Mentioning something like that sounds like a good plan.

@crlf0710
Copy link
Member Author

Addressed the comments above. Please review again to see if there's more to be adjusted.

Copy link
Member

@mark-i-m mark-i-m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @crlf0710 ! This looks great :)

I have two minor nits, but after that r=me

src/SUMMARY.md Outdated Show resolved Hide resolved
src/traits/lowering-module.md Show resolved Hide resolved
@crlf0710
Copy link
Member Author

crlf0710 commented Apr 25, 2020

Wait, https://rust-lang.github.io/chalk/book/ is now 404. Did we have a url change or something?

EDIT: pending on https://rust-lang.zulipchat.com/#narrow/stream/144729-wg-traits/topic/Chalk.20book.20address.20change.2E

Co-Authored-By: Who? Me?! <mark-i-m@users.noreply.github.com>
@crlf0710
Copy link
Member Author

Comments are addressed, and seems CI passes now.

Copy link
Member

@mark-i-m mark-i-m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks again!

@mark-i-m mark-i-m merged commit bdf565d into rust-lang:master Apr 25, 2020
@crlf0710 crlf0710 deleted the chalk-cleanup branch April 25, 2020 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants