Update some stale doc comments

This commit is contained in:
Johannes Altmanninger 2024-12-21 19:41:41 +01:00
parent 7ec1487016
commit 48ae19b4b1
2 changed files with 4 additions and 6 deletions

View file

@ -64,8 +64,8 @@ impl FdReadableSet {
fd >= 0 && unsafe { libc::FD_ISSET(fd, &self.fdset_) } fd >= 0 && unsafe { libc::FD_ISSET(fd, &self.fdset_) }
} }
/// Call `select()` or `poll()`, according to FISH_READABLE_SET_USE_POLL. Note this /// Call `select()`. Note this destructively modifies the set. Returns the result of
/// destructively modifies the set. Returns the result of `select()` or `poll()`. /// `select()`.
pub fn check_readable(&mut self, timeout_usec: u64) -> c_int { pub fn check_readable(&mut self, timeout_usec: u64) -> c_int {
let null = std::ptr::null_mut(); let null = std::ptr::null_mut();
let mut tvs; let mut tvs;
@ -188,8 +188,7 @@ impl FdReadableSet {
}; };
} }
/// Call select() or poll(), according to FISH_READABLE_SET_USE_POLL. Note this destructively /// Call poll(). Note this destructively modifies the set. Return the result of poll().
/// modifies the set. Return the result of select() or poll().
/// ///
/// TODO: Change to [`Duration`](std::time::Duration) once FFI usage is done. /// TODO: Change to [`Duration`](std::time::Duration) once FFI usage is done.
pub fn check_readable(&mut self, timeout_usec: u64) -> c_int { pub fn check_readable(&mut self, timeout_usec: u64) -> c_int {

View file

@ -122,8 +122,7 @@ pub struct Cursor {
pub struct ScreenData { pub struct ScreenData {
line_datas: Vec<Line>, line_datas: Vec<Line>,
/// The width of the screen in this rendering. /// The width of the screen once we have rendered.
/// -1 if not set, i.e. we have not rendered before.
screen_width: Option<usize>, screen_width: Option<usize>,
cursor: Cursor, cursor: Cursor,