docs: add core module and API documentation

This commit is contained in:
Christian Visintin
2026-04-19 01:54:46 +05:30
parent abc80b93ad
commit 89de2d2dfa
6 changed files with 43 additions and 2 deletions
+3
View File
@@ -23,7 +23,9 @@ pub enum UpdateStatus {
/// Info related to a github release
#[derive(Debug)]
pub struct Release {
/// Release version string returned by GitHub.
pub version: String,
/// Release notes body returned by GitHub.
pub body: String,
}
@@ -48,6 +50,7 @@ impl Update {
self
}
/// Installs the latest available release using the configured update options.
pub fn upgrade(self) -> Result<UpdateStatus, UpdateError> {
info!("Updating termscp...");
GithubUpdater::configure()