Skip to content

Commit 76bd63e

Browse files
committed
Switch back to line (//!) doc comments now we can wrap these
These can be wrapped with either of nightly rustfmt or a patch to the WrapToColumn plugin for RustRover: abrookins/WrapToColumn#71
1 parent e0729fb commit 76bd63e

File tree

4 files changed

+22
-26
lines changed

4 files changed

+22
-26
lines changed

coretypes/src/measure.rs

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
/*!
2-
Simple zero-overhead unit of measure types
3-
4-
A poor man's version of F#'s units of measure, in order to keep units correct by
5-
construction. I wrote these rather than use the popular `uom` crate because the
6-
latter obscures the actual storage unit and numeric type.
7-
*/
1+
//! Simple zero-overhead unit of measure types
2+
//!
3+
//! A poor man's version of F#'s units of measure, in order to keep units
4+
//! correct by construction. I wrote these rather than use the popular `uom`
5+
//! crate because the latter obscures the actual storage unit and numeric type.
86
97
use std::ops::{Add, AddAssign, Div};
108

coursepointer/src/course.rs

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
/*!
2-
Abstract course elements
3-
*/
1+
//! Abstract course elements
42
53
use coretypes::GeoPoint;
64
use coretypes::measure::Meters;

coursepointer/src/gpx.rs

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
1-
/*!
2-
GPX track/route and waypoint reader
3-
4-
# Usage
5-
6-
Provides an iterator that reads in sequence the trackpoints/routepoints,
7-
waypoints, and other relevant items from a GPX track file.
8-
9-
This module treats GPX routes and tracks synonymously, except that tracks may
10-
also contain segments.
11-
12-
To use module, instantiate a [`GpxReader`] by calling
13-
[`GpxReader::from_text`] or [`GpxReader::from_reader`]. Iterating over the
14-
[`GpxReader`] will produce a sequence of [`GpxItem`] describing the
15-
contents of the input.
16-
*/
1+
//! GPX track/route and waypoint reader
2+
//!
3+
//! # Usage
4+
//!
5+
//! Provides an iterator that reads in sequence the trackpoints/routepoints,
6+
//! waypoints, and other relevant items from a GPX track file.
7+
//!
8+
//! This module treats GPX routes and tracks synonymously, except that tracks
9+
//! may also contain segments.
10+
//!
11+
//! To use this module, instantiate a [`GpxReader`] by calling
12+
//! [`GpxReader::from_text`] or [`GpxReader::from_reader`]. Iterating over the
13+
//! [`GpxReader`] will produce a sequence of [`GpxItem`] describing the
14+
//! contents of the input.
1715
1816
use std::io::BufRead;
1917
use std::num::ParseFloatError;

rustfmt.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,5 @@ unstable_features = true
22
group_imports = "StdExternalCrate"
33
imports_granularity = "Module"
44
reorder_imports = true
5+
wrap_comments = true
6+
comment_width = 80

0 commit comments

Comments
 (0)