Merge pull request #1588 from GuillaumeGomez/doc

GuillaumeGomez · web-flow · commit 80bcfb23e192 · 2025-10-02T11:52:41.000+02:00
Improve documentation of `System::refresh_cpu_specifics`
diff --git a/src/common/system.rs b/src/common/system.rs
@@ -255,7 +255,8 @@ impl System {
         self.refresh_cpu_specifics(CpuRefreshKind::everything())
     }
 
-    /// Refreshes CPUs specific information.
+    /// Refreshes CPUs specific information. It does not refresh the CPU list.
+    /// If you want to refresh the CPU list, use [`System::refresh_cpu_list`] instead.
     ///
     /// ```no_run
     /// use sysinfo::{System, CpuRefreshKind};

Original file line number	Diff line number	Diff line change
`@@ -255,7 +255,8 @@ impl System {`
`255`	`255`	`self.refresh_cpu_specifics(CpuRefreshKind::everything())`
`256`	`256`	`}`
`257`	`257`
`258`		`- /// Refreshes CPUs specific information.`
	`258`	`+ /// Refreshes CPUs specific information. It does not refresh the CPU list.`
	`259`	+ /// If you want to refresh the CPU list, use [`System::refresh_cpu_list`] instead.
`259`	`260`	`///`
`260`	`261`	/// ```no_run
`261`	`262`	`/// use sysinfo::{System, CpuRefreshKind};`