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

List of all lang items in unstable book. #45181

Merged
merged 1 commit into from Oct 18, 2017

Conversation

Havvy
Copy link
Contributor

@Havvy Havvy commented Oct 10, 2017

I don't know how to link to the source code correctly, so I just put the information aside the lang item name.

@rust-highfive
Copy link
Collaborator

r? @QuietMisdreavus

(rust_highfive has picked a reviewer for you, use r? to override)

@QuietMisdreavus
Copy link
Member

cc @rust-lang/docs

I'm 👍 👍 👍 about having this list in here. I'm not sure about the presentation, though - it would be cool to have at least an intro statement saying that this is the list and where to find each definition. Adding a proper description to each item would be ideal, but possibly out of scope to just getting the list in there in the first place.

Also, is there some way to have tidy check for this? I don't think adding lang items is nearly as widespread as adding features (if it's even done any more), but if it were, it would be cool to make sure they were listed here. It would also help to somewhat automate putting the right source file in there, to make sure the docs don't diverge too much. I don't remember who was responsible for the current tidy unstable-book check - @steveklabnik was that you, or do you know?

@GuillaumeGomez
Copy link
Member

It's a bit difficult to find what we're looking for. Maybe sort alphabetically?

@aidanhs aidanhs added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 12, 2017
@Havvy
Copy link
Contributor Author

Havvy commented Oct 13, 2017

I've rebased with @QuietMisdreavus's requested change w.r.t. a sentence describing what the list is.

For @GuillaumeGomez's suggestion, I don't think fully alphabetical is useful. Instead, I put them in each sections. I guess I could have alphabetized each section though...I'll do that if I have to do some other change.

Really, this list is supposed to be a springboard for people actually documenting what each lang item is (and can easily be turned into a tracking issue) at some point in the future; probably after the impl period? So I'd like to just get it in there for now, and not be perfect.

- const_ptr: libcore/ptr.rs
- mut_ptr: libcore/ptr.rs
- unsafe_cell: libcore/cell.rs
- Rutime
Copy link
Member

Choose a reason for hiding this comment

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

should be Runtime

@kennytm kennytm added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 15, 2017
Copy link
Member

@QuietMisdreavus QuietMisdreavus left a comment

Choose a reason for hiding this comment

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

  • Could you wrap the lang-item names and the paths in backticks, just so we don't have errant underscores mangling the output?
  • I kinda feel like coerce_unsized belongs more with the "Other" items rather than with the rest of the operators, since it's not really describing an operator in the same way as index or bitxor, but a behavior. (It just happens to be defined alongside the rest of the operators. >_>)

@@ -99,7 +99,7 @@ libc = { version = "0.2.14", default-features = false }
```

Note that the default features have been disabled. This is a critical step -
**the default features of libc include the standard library and so must be
- -*the default features of libc include the standard library and so must be
Copy link
Member

Choose a reason for hiding this comment

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

Looks like a misplaced change here?

- eh_personality: libpanic_unwind/seh.rs (SEH)
- eh_unwind_resume: libpanic_unwind/seh64_gnu.rs (SEH64 GNU)
- eh_unwind_resume: libpanic_unwind/gcc.rs (GCC)
- msvc_try_filter": libpanic_unwind/seh.rs (SEH)
Copy link
Member

Choose a reason for hiding this comment

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

Errant quote?

Copy link
Member

@QuietMisdreavus QuietMisdreavus left a comment

Choose a reason for hiding this comment

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

Gets a 👍 from me with this, though I'd like to wait on @steveklabnik and @frewsxcv to make sure the whole docs team sees it before giving an r+.

- Runtime
- `start`: `libstd/rt.rs`
- `eh_personality`: `libpanic_unwind/emcc.rs (EMCC)`
- `eh_personality`: `libpanic_unwind/seh64_gnu.rs (SEH64 GNU)`
Copy link
Member

Choose a reason for hiding this comment

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

I guess these platform markers should go outside the backticks for the filename.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes....

@kennytm kennytm added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 17, 2017
Copy link
Member

@frewsxcv frewsxcv left a comment

Choose a reason for hiding this comment

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

minus my comments, looks great to me!

- `i128`: `libcore/num/mod.rs`
- `isize`: `libcore/num/mod.rs`
- `isize`: `libcore/num/mod.rs`
- `isize`: `libcore/num/mod.rs`
Copy link
Member

Choose a reason for hiding this comment

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

looks like isize is repeated (same with usize below)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

How did I not see that? (It's defined once for each configuration of pointer size.)

@kennytm kennytm added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 17, 2017
@frewsxcv
Copy link
Member

thanks!

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Oct 18, 2017

📌 Commit 1287300 has been approved by frewsxcv

@kennytm kennytm added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 18, 2017
kennytm added a commit to kennytm/rust that referenced this pull request Oct 18, 2017
…ewsxcv

List of all lang items in unstable book.

I don't know how to link to the source code correctly, so I just put the information aside the lang item name.
bors added a commit that referenced this pull request Oct 18, 2017
Rollup of 10 pull requests

- Successful merges: #44138, #45082, #45098, #45181, #45217, #45281, #45325, #45326, #45340, #45354
- Failed merges:
@alexcrichton alexcrichton merged commit 1287300 into rust-lang:master Oct 18, 2017
@Havvy Havvy deleted the doc-unstable-lang-items branch October 19, 2017 00:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

10 participants