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

Add example of a [[...]] section to src/doc/manifest.md #2992

Closed
casey opened this issue Aug 15, 2016 · 4 comments · Fixed by #6393
Closed

Add example of a [[...]] section to src/doc/manifest.md #2992

casey opened this issue Aug 15, 2016 · 4 comments · Fixed by #6393
Assignees
Labels
A-documenting-cargo-itself Area: Cargo's documentation

Comments

@casey
Copy link
Contributor

casey commented Aug 15, 2016

Currentlly, http://doc.crates.io/manifest.html mentions [[...]] style sections but doesn't include an example of one.

I would suggest adding an example of a simple [[bin]] item, so that users don't need to refer to the TOML spec to understand how to use them.

For example:

[[bin]]
name = "my-cool-binary"
path = "src/my-cool-binary.rs"
@panicbit
Copy link

The manifest already gives an example using a [lib] section and also mentions that it works the same for the other section types. IMO that should be enough, since the only difference is an additional pair of brackets.

@casey
Copy link
Contributor Author

casey commented Aug 15, 2016

Well, just speaking for myself, it wasn't at all obvious to me how to do it from the current description.

@panicbit
Copy link

Yeah, a few people on IRC (me included) didn't realise this, so maybe a bit of paraphrasing is needed.

@alexcrichton alexcrichton added the A-documenting-cargo-itself Area: Cargo's documentation label Aug 15, 2016
@alexcrichton
Copy link
Member

Seems reasonable to me!

@dwijnand dwijnand self-assigned this Dec 7, 2018
bors added a commit that referenced this issue Dec 7, 2018
…fest-docs, r=alexcrichton

Add an array of tables example to the manifest docs

Fixes #2992
@bors bors closed this as completed in #6393 Dec 7, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documenting-cargo-itself Area: Cargo's documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants