Documentation sprint: Terminfo documentation strings #12948
Conversation
| @@ -106,6 +110,7 @@ fn cap_for_attr(attr: attr::Attr) -> &'static str { | |||
| } | |||
| } | |||
|
|
|||
| #[doc(hidden)] | |||
There was a problem hiding this comment.
Why is this hidden? I thought this was one of the main exports of this library?
There was a problem hiding this comment.
I did not know how to do explain the "all the fields of this are priv", yet the main thing is not, so a very short docstring, like Wraps an output stream and its terminal settings may do the trick.
Thanks for picking this piece of lint.
There was a problem hiding this comment.
This structure is one of the main exports of this library, just because its fields are private doesn't mean that it's a useless structure. The HashMap structure, for example, has no public fields.
Documentation on structs normally explains what it's used for and why, accompanied with an example or two of its usage.
|
A good check would be to put |
|
@alexcrichton is this ready to go yet? |
|
Not quite, I still have some comments that I would like addressed |
|
|
And, now it also built green. @alexcrichton @brson Would this suffice? |
| @@ -20,6 +20,8 @@ | |||
| html_root_url = "http://static.rust-lang.org/doc/master")]; | |||
|
|
|||
| #[feature(macro_rules)]; | |||
| #[allow(deprecated_owned_vector)]; // NOTE: remove after stage0 | |||
There was a problem hiding this comment.
A new snapshot was created today, this line could go away already.
|
@olleolleolle would you mind squashing the commits? |
|
@flaper87 Thanks for picking that up. 🍰 |
|
(Darned thing stopped, "no output for 10 minutes" error.) |
|
Thanks, @kud1ing for noting Markdown deficiency. |
Rust doc sprint: adding doc strings to the Terminfo library. This is my very first Rust repository PR, so please do not hold back any formatting, nit-picky commentary. I need it.
feat: Handle operators like their trait functions in the IDE Allows hover and goto implementation to work on `?`, indexing brackets, binary operators, prefix operators and `await`. Regarding `await`, hover will continue to show the keyword docs while goto implementation will bring the user to the `poll` function of the `Future` implementation.  Fixes rust-lang/rust-analyzer#12810
Rust doc sprint: adding doc strings to the Terminfo library.
This is my very first Rust repository PR, so please do not hold back any formatting, nit-picky commentary. I need it.