Skip to content

Commit ec63923

Browse files
refactor: add doc comments on the LinkInfo
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 557d41c commit ec63923

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/git/mod.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,13 @@ use std::env;
55
use std::fs;
66

77
#[derive(Debug, Clone, Serialize, Deserialize)]
8+
/// Represents a hyperlink found in a repository, along with its location.
89
pub struct LinkInfo {
10+
/// The URL string. This should be a valid HTTP or HTTPS URL.
911
pub url: String,
12+
/// The relative file path where the URL was found.
1013
pub file_path: String,
14+
/// The 1-based line number in the file where the URL was found.
1115
pub line_number: usize,
1216
}
1317

0 commit comments

Comments
 (0)