-
Notifications
You must be signed in to change notification settings - Fork 13.4k
API Docs: macros #29381
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Labels
A-docs
Area: Documentation for any part of the project, including the compiler, standard library, and tools
C-tracking-issue
Category: An issue tracking the progress of sth. like the implementation of an RFC
E-help-wanted
Call for participation: Help is requested to fix this issue.
E-medium
Call for participation: Medium difficulty. Experience needed to fix: Intermediate.
E-mentor
Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.
P-medium
Medium priority
Comments
51 tasks
Not sure it's within the scope of this issue (since this is about the content), but see #26560. |
I am happy to mentor anyone who wants to tackle this issue. |
I'll take a look at these @steveklabnik |
@dpen2000 awesome! Let me know if you need anything 😄 |
frewsxcv
added a commit
to frewsxcv/rust
that referenced
this issue
Mar 31, 2017
…s, r=steveklabnik Improve the docs for the write and writeln macros This change reduces duplication by linking the documentation for `writeln!` to `write!`. It also restructures the `write!` documentation to read in a more logical manner (I hope; feedback would be welcome). Updates rust-lang#29329, rust-lang#29381
michaelwoerister
pushed a commit
to michaelwoerister/rust
that referenced
this issue
Apr 7, 2017
This change reduces duplication by linking the documentation for `writeln!` to `write!`. It also restructures the `write!` documentation to read in a more logical manner. Updates rust-lang#29329, rust-lang#29381
@steveklabnik Seems like I'll try to work through |
citizen428
added a commit
to citizen428/rust
that referenced
this issue
Jun 6, 2017
frewsxcv
added a commit
to frewsxcv/rust
that referenced
this issue
Jun 7, 2017
…r=steveklabnik Doc changes for assert macros See rust-lang#29381
alexcrichton
added a commit
to alexcrichton/rust
that referenced
this issue
Aug 30, 2017
…labnik API docs: macros. Standard Documentation Checklist Fixes rust-lang#29381 r? @steveklabnik
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Labels
A-docs
Area: Documentation for any part of the project, including the compiler, standard library, and tools
C-tracking-issue
Category: An issue tracking the progress of sth. like the implementation of an RFC
E-help-wanted
Call for participation: Help is requested to fix this issue.
E-medium
Call for participation: Medium difficulty. Experience needed to fix: Intermediate.
E-mentor
Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.
P-medium
Medium priority
Uh oh!
There was an error while loading. Please reload this page.
Part of #29329
http://doc.rust-lang.org/std/#macros
Here's what needs to be done to close out this issue:
assert
could use links topanic!
, and "This macro has a second version," should be about one and two argument forms, not "versions". In general, these docs could use some headers for each bit, rather than the rambly style they're in now.assert_eq
could use links toassert!
, also dropping the()
. same deal with "versions" too. Mentioning its relationship toPartialEq
would be nice.assert_ne
has the same issues asassert_eq!
.column
needs to drop the()
s, and doesn't explain why you might care about the column that it was invoked in.debug_assert
needs a bunch of links, and should really end up mostly pointing to the docs ofassert
.debug_assert_eq
same asdebug_assert
, that is, should mostly point toassert_eq
.debug_assert_ne
, same as the two previous.file!
same ascolumn!
format!
this macro is very useful and has very little docs, what a shame! It should have a lot more, at least pointing out that it's a common way to concatenate a lot of strings, for example.format_args
could use a lot of work, mostly expanding on what it is and why it's there.include
this macro explains why it's bad but then doesn't show an example. It should.line!
similar tocolumn!
option_env!
needs links toOption<T>
panic!
has anemic docs for something so heavily used!print!
could use a bunch of linksprintln!
could use linksthread_local
should link when it mentionsLocalKey
, not at the end.try!
should be a little more strongly worded about?
and should show examples of their equivalence.unreachable!
should discuss how it's different than the intrinsic.vec!
could use a lot of links and some more text.write!
has just... awkward docs. It's a weird macro, so that's why, but it could use re-done, IMHO.writeln
should mostly link towrite!
and point out that it's the same but with the extra newline.The text was updated successfully, but these errors were encountered: