The Wayback Machine - https://web.archive.org/web/20201228171925/https://github.com/rust-lang/reference/pull/423
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

document inferring outlives requirements (RFC 2093) #423

Open
wants to merge 4 commits into
base: master
from

Conversation

@toidiu
Copy link

@toidiu toidiu commented Sep 21, 2018

@alercah adding documentation to go along with the feature stabilization

@toidiu
Copy link
Author

@toidiu toidiu commented Sep 21, 2018

My first time committing to this repo so please let me know if I made any errors.

@toidiu
Copy link
Author

@toidiu toidiu commented Feb 11, 2019

@alercah realized this has been marinating for awhile now

@alercah
Copy link
Contributor

@alercah alercah commented Feb 11, 2019

I'm no longer on the docs team, someone else should take a look. @Havvy or @Centril ?

Copy link
Contributor

@Centril Centril left a comment

My general concern here is that this is documented as a separate thing rather than being integrated with other parts of the reference. The text is also written in a guide-level manner rather than as reference text. However, it's still an improvement no docs at all.

Also, please make sure that all the examples actually compile on stable which they don't atm.

src/inferring-outlive-requirements.md Outdated Show resolved Hide resolved
src/inferring-outlive-requirements.md Outdated Show resolved Hide resolved
src/inferring-outlive-requirements.md Outdated Show resolved Hide resolved
src/inferring-outlive-requirements.md Outdated Show resolved Hide resolved
src/inferring-outlive-requirements.md Outdated Show resolved Hide resolved
src/inferring-outlive-requirements.md Outdated Show resolved Hide resolved
src/inferring-outlive-requirements.md Outdated Show resolved Hide resolved
src/inferring-outlive-requirements.md Show resolved Hide resolved
src/inferring-outlive-requirements.md Show resolved Hide resolved
src/inferring-outlive-requirements.md Outdated Show resolved Hide resolved
@Centril Centril self-assigned this Feb 11, 2019
@toidiu toidiu force-pushed the toidiu:ak-docs-outlives-requirements branch from e705816 to 9a625c1 Feb 22, 2019
@toidiu toidiu force-pushed the toidiu:ak-docs-outlives-requirements branch from 9a625c1 to f6c8e24 Feb 22, 2019
@toidiu toidiu force-pushed the toidiu:ak-docs-outlives-requirements branch from f6c8e24 to 7a81ab9 Feb 22, 2019
@toidiu
Copy link
Author

@toidiu toidiu commented Feb 22, 2019

@Centril Thanks for the review and comments! I have updated the pr as per your advice.

this is documented as a separate thing rather than being integrated with other parts of the reference. The text is also written in a guide-level manner rather than as reference text

Do you have a suggestion how I can improve this?

please make sure that all the examples actually compile on stable which they don't atm

Can I do a cargo test rather than checking each snippet of code? Used Rust playground to test all the examples. They should compile now.

src/inferring-outlive-requirements.md Outdated Show resolved Hide resolved
src/inferring-outlive-requirements.md Outdated Show resolved Hide resolved
src/inferring-outlive-requirements.md Outdated Show resolved Hide resolved
src/inferring-outlive-requirements.md Outdated Show resolved Hide resolved
src/inferring-outlive-requirements.md Outdated Show resolved Hide resolved
src/inferring-outlive-requirements.md Outdated Show resolved Hide resolved
src/inferring-outlive-requirements.md Outdated Show resolved Hide resolved
src/inferring-outlive-requirements.md Outdated Show resolved Hide resolved
src/inferring-outlive-requirements.md Outdated Show resolved Hide resolved
@Centril
Copy link
Contributor

@Centril Centril commented Feb 22, 2019

Do you have a suggestion how I can improve this?

Before going into the examples, I would try to describe the set of rules, as a list, that give rise to your included examples (which are helpful).
E.g.

  • &'foo Bar being well-formed implies Bar: 'foo
@toidiu
Copy link
Author

@toidiu toidiu commented Mar 26, 2019

Sry it took so long to get back to this; been very busy. I had meant to do the improved version of the documentation but settling for getting something out.

@Centril Centril requested a review from ehuss Mar 26, 2019
@Centril Centril dismissed their stale review Mar 26, 2019

done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.