[Crate] Changeup a doc comment

This commit is contained in:
CosminPerRam 2023-09-10 23:27:06 +03:00
parent cb0486bded
commit 6179532065

View file

@ -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: