Skip to content

Commit c75de7e

Browse files
committed
doc: End all doc comments with a period.
1 parent 465d9be commit c75de7e

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

src/term.rs

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ impl Term {
143143
term
144144
}
145145

146-
/// Return a new unbuffered terminal
146+
/// Return a new unbuffered terminal.
147147
#[inline]
148148
pub fn stdout() -> Term {
149149
Term::with_inner(TermInner {
@@ -152,7 +152,7 @@ impl Term {
152152
})
153153
}
154154

155-
/// Return a new unbuffered terminal to stderr
155+
/// Return a new unbuffered terminal to stderr.
156156
#[inline]
157157
pub fn stderr() -> Term {
158158
Term::with_inner(TermInner {
@@ -161,23 +161,23 @@ impl Term {
161161
})
162162
}
163163

164-
/// Return a new buffered terminal
164+
/// Return a new buffered terminal.
165165
pub fn buffered_stdout() -> Term {
166166
Term::with_inner(TermInner {
167167
target: TermTarget::Stdout,
168168
buffer: Some(Mutex::new(vec![])),
169169
})
170170
}
171171

172-
/// Return a new buffered terminal to stderr
172+
/// Return a new buffered terminal to stderr.
173173
pub fn buffered_stderr() -> Term {
174174
Term::with_inner(TermInner {
175175
target: TermTarget::Stderr,
176176
buffer: Some(Mutex::new(vec![])),
177177
})
178178
}
179179

180-
/// Return a terminal for the given Read/Write pair styled-like Stderr.
180+
/// Return a terminal for the given Read/Write pair styled like stderr.
181181
#[cfg(unix)]
182182
pub fn read_write_pair<R, W>(read: R, write: W) -> Term
183183
where
@@ -204,7 +204,7 @@ impl Term {
204204
})
205205
}
206206

207-
/// Return the style for this terminal
207+
/// Return the style for this terminal.
208208
#[inline]
209209
pub fn style(&self) -> Style {
210210
match self.inner.target {
@@ -215,7 +215,7 @@ impl Term {
215215
}
216216
}
217217

218-
/// Return the target of this terminal
218+
/// Return the target of this terminal.
219219
#[inline]
220220
pub fn target(&self) -> TermTarget {
221221
self.inner.target.clone()
@@ -402,7 +402,7 @@ impl Term {
402402
move_cursor_to(self, x, y)
403403
}
404404

405-
/// Move the cursor up `n` lines
405+
/// Move the cursor up `n` lines.
406406
#[inline]
407407
pub fn move_cursor_up(&self, n: usize) -> io::Result<()> {
408408
move_cursor_up(self, n)
@@ -414,13 +414,13 @@ impl Term {
414414
move_cursor_down(self, n)
415415
}
416416

417-
/// Move the cursor `n` characters to the left
417+
/// Move the cursor `n` characters to the left.
418418
#[inline]
419419
pub fn move_cursor_left(&self, n: usize) -> io::Result<()> {
420420
move_cursor_left(self, n)
421421
}
422422

423-
/// Move the cursor `n` characters to the right
423+
/// Move the cursor `n` characters to the right.
424424
#[inline]
425425
pub fn move_cursor_right(&self, n: usize) -> io::Result<()> {
426426
move_cursor_right(self, n)
@@ -466,21 +466,21 @@ impl Term {
466466
clear_chars(self, n)
467467
}
468468

469-
/// Set the terminal title
469+
/// Set the terminal title.
470470
pub fn set_title<T: Display>(&self, title: T) {
471471
if !self.is_tty {
472472
return;
473473
}
474474
set_title(title);
475475
}
476476

477-
/// Make the cursor visible again
477+
/// Make the cursor visible again.
478478
#[inline]
479479
pub fn show_cursor(&self) -> io::Result<()> {
480480
show_cursor(self)
481481
}
482482

483-
/// Hide the cursor
483+
/// Hide the cursor.
484484
#[inline]
485485
pub fn hide_cursor(&self) -> io::Result<()> {
486486
hide_cursor(self)

0 commit comments

Comments
 (0)