-
Notifications
You must be signed in to change notification settings - Fork 544
start to document MIR borrow check #190
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
start to document MIR borrow check #190
Conversation
ae4bc4d
to
3b2d76a
Compare
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.
Reads well from a semi-outsiders perspective; very nice high level explanation.
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.
src/borrow_check/type_check.md
Outdated
this type-check, we also uncover the region constraints that apply to | ||
the program. | ||
|
||
|
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.
Did you intend to write more here? Could you leave a TODO?
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.
Not sure if I did or not.
I have to say, I also find our "long line" check pretty annoying. |
Seems like it should be more like a max limit of 90 or 100 or something. |
Or, at minimum, less annoying for me to check locally (there isn't a convenient command). |
ok, passes locally anyway... |
I'm fine with making the line length longer. |
If you want to make it 100 in this PR to make travis pass, I think that would be ok too... |
@nikomatsakis I would like to merge #184, but this will require you to fix a bunch of links in this PR and in others. Would you prefer for me to wait? |
@mark-i-m ok I bumped to 100 so that summary.md can be committed (and just so that things are less irritating) As for the upgrade, I guess it could go in any order, but I'd like to land these PRs, yes. What is the new link format? |
New: Relative to the current file For example, if you are editing appendix/glossary.md and you want to link to traits/lowering-rules.md: New: ../traits/lowering-rules.md |
@mark-i-m ah, nice. that confuses me all the time. |
well I'm game for either order. I would say this PR is ready to land. |
ca77bd5
to
7b9dcc4
Compare
otherwise our summary.md doesn't fit
7b9dcc4
to
a72a068
Compare
Make an effort to start documenting the MIR borrow checker. In this first pass, all I managed to do was to write about move-paths and how they work.
Also, promote the borrow checker to its own top-level section.