1661811 - Move obsolete/deprecated sections in telemetry.rst to make it less misleading

Status: RESOLVED FIXED

(Firefox :: Address Bar, enhancement, P3)

Description

[Drew Willcoxon :adw]

I was looking at telemetry.rst today to answer a question about telemetry. Recently I added sections for FX_URLBAR_SELECTED_RESULT_TYPE_2 and FX_URLBAR_SELECTED_RESULT_INDEX_BY_TYPE_2 (note the trailing _2), but I added them after the obsoleted sections. So as you're reading the document, you first encounter the obsolete information, and if you're not careful, you may think you've found the information you're looking for. The obsolete sections should come after the current sections, or maybe even at the end in a section just for obsolete/deprecated info.

Comment 1

[Drew Willcoxon :adw]

Attachment: Bug 1661811 - Move obsolete/deprecated sections in telemetry.rst to make it less misleading.

This adds an Obsolete section to the doc. I overused the word "obsolete" in
order to make it hard for your eyes to skip over just an "Obsolete" section
heading as you're skimming this page for info.

Also, SELECTED_RESULT_TYPES by itself wasn't clear, so I changed it to
UrlbarUtils.SELECTED_RESULT_TYPES and added a link that shouldn't be broken by
future changes.

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/a819df5c1717
Move obsolete/deprecated sections in telemetry.rst to make it less misleading. r=mak

Comment 3

[Atila Butkovits]

https://hg.mozilla.org/mozilla-central/rev/a819df5c1717