Added information about examples as libraries to the documentation #3582
Conversation
|
@alexcrichton, |
| @@ -451,13 +451,19 @@ To structure your code after you've created the files and folders for your proje | |||
| Files located under `examples` are example uses of the functionality provided by | |||
| the library. When compiled, they are placed in the `target/examples` directory. | |||
|
|
|||
| They must compile as executables (with a `main()` function) and load in the | |||
There was a problem hiding this comment.
Perhaps this paragraph could be:
They can compile as executables (with a
main()function) or libraries and pull in the main library throughextern crate <library-name>. Examples are compiled when you run your tests to prevent them from bitrotting.
There was a problem hiding this comment.
@alexcrichton,
I am not a native speaker, so if you say so I will change.
I am curious.
Why my sentence is invalid?
There was a problem hiding this comment.
Oh there wasn't anything wrong with it, it just seemed to not flow well having two sentences starting with 'They' back-to-back.
There was a problem hiding this comment.
Thoughts on updating this paragraph?
There was a problem hiding this comment.
I have already updated it.
| <example-name>`. | ||
|
|
||
| Specify `crate-type` to make an example be compiled as a library: | ||
| ```toml | ||
| [[example.example]] |
There was a problem hiding this comment.
I think this is just [[example]], right?
There was a problem hiding this comment.
No, it isn't.
.example means an example with name example.
Should I change it to .foo?
There was a problem hiding this comment.
Ok well as the author of Cargo and implementor of this feature I'm saying [[example.example]] is invalid. The correct syntax is [[example]]
There was a problem hiding this comment.
@alexcrichton,
Yes, indeed.
I am sorry.
I saw that somewhere. I will change that.
[ci skip]
| <example-name>`. | ||
|
|
||
| Specify `crate-type` to make an example be compiled as a library: | ||
| ```toml | ||
| [[example.foo]] |
There was a problem hiding this comment.
The '.foo' here needs to be removed as well.
There was a problem hiding this comment.
It seems to me that I am stupid.
Sorry.
|
@bors: r+ |
|
📌 Commit 5caee7f has been approved by |
…es, r=alexcrichton Added information about examples as libraries to the documentation [Allow examples to be library](#3556) has been committed. The PR adds information to the documentation.
|
@alexcrichton, |
|
☀️ Test successful - status-appveyor, status-travis |
Allow examples to be library has been committed.
The PR adds information to the documentation.