WIP

agama-project · Sep 5, 2024 · 3083d2b · 3083d2b
1 parent 7019e69
commit 3083d2b
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/service/test/y2storage/agama_proposal_test.rb b/service/test/y2storage/agama_proposal_test.rb
@@ -24,6 +24,9 @@
 require "agama/storage/config"
 require "y2storage/agama_proposal"
 
+# @param config [Agama::Storage::Configs::Drive, Agama::Storage::Configs::Partition]
+# @param name [String, nil] e.g., "/dev/vda"
+# @param filesystem [String, nil] e.g., "xfs"
 def block_device_config(config, name: nil, filesystem: nil)
   if name
     config.search = Agama::Storage::Configs::Search.new.tap do |search_config|
@@ -42,11 +45,16 @@ def block_device_config(config, name: nil, filesystem: nil)
   config
 end
 
+# @param name [String, nil] e.g., "/dev/vda"
+# @param filesystem [String, nil] e.g., "xfs"
 def drive_config(name: nil, filesystem: nil)
   config = Agama::Storage::Configs::Drive.new
   block_device_config(config, name: name, filesystem: filesystem)
 end
 
+# @param name [String, nil] e.g., "/dev/vda"
+# @param filesystem [String, nil] e.g., "xfs"
+# @param size [Y2Storage::DiskSize]
 def partition_config(name: nil, filesystem: nil, size: nil)
   config = Agama::Storage::Configs::Partition.new
   block_device_config(config, name: name, filesystem: filesystem)