Skip to content

Commit 8e7a9c4

Browse files
authored
Update Telemetry.pod6
1 parent d1d1061 commit 8e7a9c4

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

doc/Type/Telemetry.pod6

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
class Telemetry { }
88
class Telemetry::Period { }
99
10+
B<Note: > This class is a Rakudo-specific feature and not standard Perl 6.
11+
1012
On creation, a C<Telemetry> object contains a snapshot of the current state
1113
of the virtual machine. This is in itself useful, but generally one needs
1214
two snapshots for the difference (which is a C<Telemetry::Period> object).
@@ -22,7 +24,7 @@ use Telemetry :COLUMNS; # imports all of the possible columns of report
2224
use Telemetry < cpu wallclock snap >; # only imports cpu, wallclock and snap
2325
=end code
2426
25-
=head2 available data
27+
=head1 Available Data
2628
2729
=item affinity-tasks-completed
2830
@@ -109,7 +111,7 @@ my $t = Telemetry.new;
109111
say "Used $t (cpu / wallclock) microseconds to execute so far";
110112
=end code
111113
112-
=head1 Additional subroutines
114+
=head1 Methods
113115
114116
=head2 routine T
115117
@@ -203,7 +205,7 @@ pushes.
203205
204206
=head3 additional named parameters
205207
206-
=item :columns
208+
=item C<:columns>
207209
208210
Specify the names of the columns to be included in the report. Names can
209211
be specified with the full method name (e.g. C<general-workers>) or with
@@ -214,14 +216,14 @@ If that is not set either, defaults to:
214216
=for code :skip-test
215217
wallclock util% max-rss gw gtc tw ttc aw atc
216218
217-
=item :header-repeat
219+
=item C<:header-repeat>
218220
219221
Specifies after how many lines the header should be repeated in the report.
220222
If not specified, defaults to what is specified in the
221223
C<RAKUDO_REPORT_HEADER_REPEAT> environment variable. If that is not set either,
222224
defaults to 32.
223225
224-
=item :legend
226+
=item C<:legend>
225227
226228
Specifies whether a legend should be added to the report. If not specified,
227229
defaults to what is specified in the C<RAKUDO_REPORT_LEGEND> environment variable.

0 commit comments

Comments
 (0)