Skip to content
This repository was archived by the owner on Oct 9, 2018. It is now read-only.

stop using doc comments in line comment example #15

Merged
merged 1 commit into from
Jul 8, 2014
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions style/comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,20 @@

### Avoid block comments.

Use line comments instead:
Use line comments:

``` rust
/// Creates and executes a new child task
///
/// Sets up a new task with its own call stack and schedules it to run
/// the provided unique closure.
///
/// This function is equivalent to `TaskBuilder::new().spawn(f)`.
pub fn spawn(f: proc():Send) { ... }
// Wait for the main task to return, and set the process error code
// appropriately.
```

Instead of:

``` rust
/*
* Wait for the main task to return, and set the process error code
* appropriately.
*/
```

## Doc comments
Expand Down