Merge pull request #291 from eminence/cpuinfo_docs

Clarify CpuInfo.get_field docs
eminence · Nov 21, 2023 · a00c3fc · a00c3fc
2 parents fa6e798 + bc33001
commit a00c3fc
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/procfs-core/src/cpuinfo.rs b/procfs-core/src/cpuinfo.rs
@@ -110,7 +110,11 @@ impl CpuInfo {
 
     /// Get the content of a specific field associated to a CPU
     ///
-    /// Returns None if the requested cpu index is not found.
+    /// If the field is not found in the set of CPU-specific fields, then
+    /// it is returned from the set of common fields.
+    ///
+    /// Returns None if the requested cpu index is not found, or if the field
+    /// is not found.
     pub fn get_field(&self, cpu_num: usize, field_name: &str) -> Option<&str> {
         self.cpus.get(cpu_num).and_then(|cpu_fields| {
             cpu_fields