Bug 1912808 - Fix document generation warnings from Glean docs. r=chutten

Differential Revision: https://phabricator.services.mozilla.com/D220493
This commit is contained in:
Mark Banner
2024-08-29 15:21:53 +00:00
parent cf17fd9bd1
commit c0a77b72e3
3 changed files with 4 additions and 4 deletions

View File

@@ -126,4 +126,4 @@ fatal warnings:
- "WARNING: '([^']*)' reference target not found:((?!.rst).)*$"
- "WARNING: Include file '([^']*)' not found or reading it failed"
max_num_warnings: 845
max_num_warnings: 844

View File

@@ -42,11 +42,11 @@ which means that testing the Legacy Telemetry event or seeing its value in `abou
[requires a full, compiled build][artifact-support-gifft].
[new-metrics-yaml]: ./new_definitions_file.md#where-do-i-define-new-metrics-and-pings
[glean-events-vs]: ./migration.md#events-use-glean-s-event
[glean-events-vs]: ./migration.md#events---use-gleans-event
[glean-event-doc]: https://mozilla.github.io/glean/book/reference/metrics/event.html
[sample-event-defn]: https://mozilla.github.io/glean/book/reference/metrics/event.html#metric-parameters
[gifft]: ./gifft.md
[legacy-enum-name]: ./gifft.md#the-telemetry-mirror-property-in-metrics-yaml
[legacy-enum-name]: ./gifft.md#the-telemetry_mirror-property-in-metricsyaml
[glean-event-api]: https://mozilla.github.io/glean/book/reference/metrics/event.html#recordobject
[glean-test-api]: https://mozilla.github.io/glean/book/reference/metrics/event.html#testing-api
[artifact-support-gifft]: ./gifft.md#artifact-build-support

View File

@@ -47,7 +47,7 @@ you're going to want to write some automated tests.
* You might be able to assert that the value is at least as much as a known, timed value,
but beware of rounding.
* If your metric is a `timing_distribution` mirroring to a Telemetry probe via [GIFFT](./gifft.md),
there may be [small observed differences between systems](./gifft.md#timing-distribution-mirrors-samples-and-sums-might-be-different)
there may be [small observed differences between systems](./gifft.md#timing_distribution-mirrors-samples-and-sums-might-be-different)
that can cause equality assertions to fail.
* Errors in instrumentation APIs do not panic, throw, or crash.
But Glean remembers that the errors happened.