mirror of
https://github.com/tribufu/rust-gamedig
synced 2026-06-01 09:42:41 +00:00
[Crate] Changeup a doc comment
This commit is contained in:
parent
cb0486bded
commit
6179532065
1 changed files with 5 additions and 6 deletions
|
|
@ -149,9 +149,8 @@ pub struct TimeoutSettings {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl TimeoutSettings {
|
impl TimeoutSettings {
|
||||||
/// Construct new settings, passing None will block indefinitely. Passing
|
/// Construct new settings, passing None will block indefinitely.
|
||||||
/// zero Duration throws
|
/// Passing zero Duration throws GDErrorKind::[InvalidInput].
|
||||||
/// GDErrorKind::[InvalidInput].
|
|
||||||
pub fn new(read: Option<Duration>, write: Option<Duration>) -> GDResult<Self> {
|
pub fn new(read: Option<Duration>, write: Option<Duration>) -> GDResult<Self> {
|
||||||
if let Some(read_duration) = read {
|
if let Some(read_duration) = read {
|
||||||
if read_duration == Duration::new(0, 0) {
|
if read_duration == Duration::new(0, 0) {
|
||||||
|
|
@ -187,9 +186,9 @@ impl Default for TimeoutSettings {
|
||||||
|
|
||||||
/// Generic extra request settings
|
/// Generic extra request settings
|
||||||
///
|
///
|
||||||
/// Fields of this struct may not be used depending on which protocol is
|
/// Fields of this struct may not be used depending on which protocol
|
||||||
/// selected, the individual fields link to the specific places they will be
|
/// is selected, the individual fields link to the specific places
|
||||||
/// used with additional documentation.
|
/// they will be used with additional documentation.
|
||||||
///
|
///
|
||||||
/// ## Examples
|
/// ## Examples
|
||||||
/// Create minecraft settings with builder:
|
/// Create minecraft settings with builder:
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue