From 898969ffe4a7ac007e53fe1fc1cb121971d6d8ed Mon Sep 17 00:00:00 2001
From: 魏曹先生 <1992414357@qq.com>
Date: Fri, 7 Nov 2025 13:24:35 +0800
Subject: Add documentation for local cached data structures

---
 crates/vcs_data/src/data/local/cached_sheet.rs | 4 ++++
 crates/vcs_data/src/data/local/latest_info.rs  | 3 +++
 2 files changed, 7 insertions(+)

(limited to 'crates/vcs_data/src')

diff --git a/crates/vcs_data/src/data/local/cached_sheet.rs b/crates/vcs_data/src/data/local/cached_sheet.rs
index 7ca1f2f..0f4eee9 100644
--- a/crates/vcs_data/src/data/local/cached_sheet.rs
+++ b/crates/vcs_data/src/data/local/cached_sheet.rs
@@ -15,6 +15,10 @@ use crate::{
 const SHEET_NAME: &str = "{sheet_name}";
 const ACCOUNT_NAME: &str = "{account}";
 
+/// # Cached Sheet
+/// The cached sheet is a read-only version cloned from the upstream repository to the local environment,
+/// automatically generated during update operations,
+/// which records the latest Sheet information stored locally to accelerate data access and reduce network requests.
 pub struct CachedSheet;
 
 impl CachedSheet {
diff --git a/crates/vcs_data/src/data/local/latest_info.rs b/crates/vcs_data/src/data/local/latest_info.rs
index 6b116d8..28434b0 100644
--- a/crates/vcs_data/src/data/local/latest_info.rs
+++ b/crates/vcs_data/src/data/local/latest_info.rs
@@ -9,6 +9,9 @@ use crate::{
     },
 };
 
+/// # Latest Info
+/// Locally cached latest information,
+/// used to cache personal information from upstream for querying and quickly retrieving member information.
 #[derive(Default, Serialize, Deserialize, ConfigFile)]
 #[cfg_file(path = CLIENT_FILE_LATEST_INFO)]
 pub struct LatestInfo {
-- 
cgit