From 3d4a0cadc950d4440251efa11b55b0bfb0afdef7 Mon Sep 17 00:00:00 2001 From: nsfisis Date: Thu, 6 Aug 2026 04:22:46 +0900 Subject: chore: drop @param/@return tags that only restate Rust types The ported docblocks copied @param and @return straight from the PHP source. When such a tag carries nothing but a type and an argument name, the Rust signature already states it, so the line is noise. Tags whose text adds prose beyond the type are kept. Co-Authored-By: Claude Opus 5 (1M context) --- crates/shirabe/src/downloader/download_manager.rs | 8 -------- crates/shirabe/src/downloader/file_downloader.rs | 1 - crates/shirabe/src/downloader/git_downloader.rs | 2 -- 3 files changed, 11 deletions(-) (limited to 'crates/shirabe/src/downloader') diff --git a/crates/shirabe/src/downloader/download_manager.rs b/crates/shirabe/src/downloader/download_manager.rs index 2aa9c74e..ea3fed41 100644 --- a/crates/shirabe/src/downloader/download_manager.rs +++ b/crates/shirabe/src/downloader/download_manager.rs @@ -180,7 +180,6 @@ impl DownloadManager { /// @param PackageInterface $package package instance /// @param string $targetDir target dir /// @param PackageInterface|null $prevPackage previous package instance in case of updates - /// @phpstan-return PromiseInterface /// /// @throws \InvalidArgumentException if package have no urls to download from /// @throws \RuntimeException @@ -270,7 +269,6 @@ impl DownloadManager { /// @param PackageInterface $package package instance /// @param string $targetDir target dir /// @param PackageInterface|null $prevPackage previous package instance in case of updates - /// @phpstan-return PromiseInterface pub async fn prepare( &self, r#type: &str, @@ -293,7 +291,6 @@ impl DownloadManager { /// /// @param PackageInterface $package package instance /// @param string $targetDir target dir - /// @phpstan-return PromiseInterface /// /// @throws \InvalidArgumentException if package have no urls to download from /// @throws \RuntimeException @@ -315,7 +312,6 @@ impl DownloadManager { /// @param PackageInterface $initial initial package version /// @param PackageInterface $target target package version /// @param string $targetDir target dir - /// @phpstan-return PromiseInterface /// /// @throws \InvalidArgumentException if initial package is not installed pub async fn update( @@ -398,7 +394,6 @@ impl DownloadManager { /// /// @param PackageInterface $package package instance /// @param string $targetDir target dir - /// @phpstan-return PromiseInterface pub async fn remove( &self, package: PackageInterfaceHandle, @@ -418,7 +413,6 @@ impl DownloadManager { /// @param PackageInterface $package package instance /// @param string $targetDir target dir /// @param PackageInterface|null $prevPackage previous package instance in case of updates - /// @phpstan-return PromiseInterface pub async fn cleanup( &self, r#type: &str, @@ -465,8 +459,6 @@ impl DownloadManager { } } - /// @return string[] - /// @phpstan-return array<'dist'|'source'>&non-empty-array fn get_available_sources( &self, package: PackageInterfaceHandle, diff --git a/crates/shirabe/src/downloader/file_downloader.rs b/crates/shirabe/src/downloader/file_downloader.rs index 19ce8b4a..48925b4b 100644 --- a/crates/shirabe/src/downloader/file_downloader.rs +++ b/crates/shirabe/src/downloader/file_downloader.rs @@ -720,7 +720,6 @@ impl FileDownloader { } impl FileDownloader { - /// @param PATHINFO_EXTENSION|PATHINFO_BASENAME $component fn get_dist_path(&self, package: PackageInterfaceHandle, component: i64) -> String { pathinfo( PhpMixed::String( diff --git a/crates/shirabe/src/downloader/git_downloader.rs b/crates/shirabe/src/downloader/git_downloader.rs index fe725507..e9c70da3 100644 --- a/crates/shirabe/src/downloader/git_downloader.rs +++ b/crates/shirabe/src/downloader/git_downloader.rs @@ -557,7 +557,6 @@ impl GitDownloader { } } - /// @phpstan-return PromiseInterface /// @throws \RuntimeException pub(crate) async fn discard_changes(&self, path: &str) -> anyhow::Result> { let path = self.normalize_path(path); @@ -593,7 +592,6 @@ impl GitDownloader { Ok(None) } - /// @phpstan-return PromiseInterface /// @throws \RuntimeException pub(crate) async fn stash_changes(&self, path: &str) -> anyhow::Result> { let path = self.normalize_path(path); -- cgit v1.3.1