Skip to content

Commit 715ccab

Browse files
committed
Improve AppSizeMetricsHelper documentation
1 parent 5bd6819 commit 715ccab

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

lib/fastlane/plugin/wpmreleasetoolkit/helper/app_size_metrics_helper.rb

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44

55
module Fastlane
66
module WPMRT
7+
# A helper class to build an App Size Metrics payload and send it to a server (or write it to disk)
8+
#
9+
# The payload generated (and sent) by this helper conforms to the API for grouped metrics described in
10+
# https://github.com/Automattic/apps-metrics
11+
#
712
class AppSizeMetricsHelper
813
# @param [Hash] group_meta Metadata common to all the metrics. Can be any arbitrary set of key/value pairs.
914
#
@@ -12,9 +17,9 @@ def initialize(group_meta = {})
1217
@metrics = []
1318
end
1419

15-
# Sets the metadata for the whole group of metrics in that payload
20+
# Sets the metadata common to the whole group of metrics in the payload being built by this helper instance
1621
#
17-
# @param [Hash] hash The metadata common to all the metrics to set on the whole payload. Can be any arbitrary set of key/value pairs
22+
# @param [Hash] hash The metadata common to all the metrics of the payload built by that helper instance. Can be any arbitrary set of key/value pairs
1823
#
1924
def meta=(hash)
2025
@meta = (hash.compact || {}).map { |key, value| { name: key.to_s, value: value } }

0 commit comments

Comments
 (0)