Bug 1536103 - Fix Sphinx Warning - Title Underline too short in 'mach doc'. r=ahal
authorchampionshuttler <shivams2799@gmail.com>
Fri, 22 Mar 2019 19:30:34 +0000
changeset 465766 5d251a7e6031cd707c83c9b22425610d3e056f1d
parent 465765 14daa74eecfb212a945ba8d2d04947fab1be0f4c
child 465767 9d97860471b45d4096acb7d9ed8c10c7d3c602ff
push id35746
push usershindli@mozilla.com
push dateSat, 23 Mar 2019 09:46:24 +0000
treeherdermozilla-central@02b7484f316b [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersahal
bugs1536103
milestone68.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1536103 - Fix Sphinx Warning - Title Underline too short in 'mach doc'. r=ahal Differential Revision: https://phabricator.services.mozilla.com/D24536
browser/docs/AddressBar.rst
intl/l10n/docs/fluent_migrations.rst
taskcluster/docs/kinds.rst
testing/marionette/doc/internals/listener.rst
testing/marionette/doc/internals/message.rst
testing/mozbase/docs/manifestparser.rst
testing/mozbase/docs/servingcontent.rst
tools/lint/docs/linters/eslint-plugin-mozilla.rst
--- a/browser/docs/AddressBar.rst
+++ b/browser/docs/AddressBar.rst
@@ -41,17 +41,17 @@ The *UrlbarQueryContext* is passed to th
 *Model*.  The model appends results to a property of *UrlbarQueryContext* in
 chunks, it sorts them through a *Muxer* and then notifies the *Controller*.
 
 See the specific components below, for additional details about each one's tasks
 and responsibilities.
 
 
 The UrlbarQueryContext
-================
+======================
 
 The *UrlbarQueryContext* object describes a single instance of a search.
 It is augmented as it progresses through the system, with various information:
 
 .. highlight:: JavaScript
 .. code::
 
   UrlbarQueryContext {
@@ -275,17 +275,17 @@ The View is the component responsible fo
 user and handling their input.
 
 .. caution
 
   The View is a replaceable component, as such what is described here is a
   reference for the default View, but may not be valid for other implementations.
 
 `UrlbarInput.jsm <https://dxr.mozilla.org/mozilla-central/source/browser/components/urlbar/UrlbarInput.jsm>`_
-----------------
+-------------------------------------------------------------------------------------------------------------
 
 Implements an input box *View*, owns an *UrlbarView*.
 
 .. highlight:: JavaScript
 .. code::
 
   UrlbarInput {
     constructor(options = { textbox, panel, controller });
@@ -326,17 +326,17 @@ Implements an input box *View*, owns an 
     focused;
     // The go button element.
     goButton;
     // The current value, can also be set.
     value;
   }
 
 `UrlbarView.jsm <https://dxr.mozilla.org/mozilla-central/source/browser/components/urlbar/UrlbarView.jsm>`_
----------------
+-----------------------------------------------------------------------------------------------------------
 
 Represents the base *View* implementation, communicates with the *Controller*.
 
 .. highlight:: JavaScript
 .. code::
 
   UrlbarView {
     // Manage View visibility.
@@ -352,17 +352,17 @@ Represents the base *View* implementatio
     onQueryFinished(queryContext);
     // Invoked when the view context changed, so that cached information about
     // the latest search is no more relevant and can be dropped.
     onViewContextChanged();
   }
 
 
 UrlbarResult
-===========
+============
 
 An `UrlbarResult <https://dxr.mozilla.org/mozilla-central/source/browser/components/urlbar/UrlbarResult.jsm>`_
 instance represents a single search result with a result type, that
 identifies specific kind of results.
 Each kind has its own properties, that the *View* may support, and a few common
 properties, supported by all of the results.
 
 .. note::
@@ -408,34 +408,34 @@ The following RESULT_TYPEs are supported
 
 
 Shared Modules
 ==============
 
 Various modules provide shared utilities to the other components:
 
 `UrlbarPrefs.jsm <https://dxr.mozilla.org/mozilla-central/source/browser/components/urlbar/UrlbarPrefs.jsm>`_
-----------------
+-------------------------------------------------------------------------------------------------------------
 
 Implements a Map-like storage or urlbar related preferences. The values are kept
 up-to-date.
 
 .. highlight:: JavaScript
 .. code::
 
   // Always use browser.urlbar. relative branch, except for the preferences in
   // PREF_OTHER_DEFAULTS.
   UrlbarPrefs.get("delay"); // Gets value of browser.urlbar.delay.
 
 .. note::
 
   Newly added preferences should always be properly documented in UrlbarPrefs.
 
 `UrlbarUtils.jsm <https://dxr.mozilla.org/mozilla-central/source/browser/components/urlbar/UrlbarUtils.jsm>`_
-----------------
+-------------------------------------------------------------------------------------------------------------
 
 Includes shared utils and constants shared across all the components.
 
 
 Telemetry Probes
 ================
 
 *Content to be written*
--- a/intl/l10n/docs/fluent_migrations.rst
+++ b/intl/l10n/docs/fluent_migrations.rst
@@ -686,17 +686,17 @@ folders `en-US` and `test`.
 
 .. code-block:: bash
 
   hg clone https://hg.mozilla.org/l10n/gecko-strings en-US
   cp -r en-US test
 
 
 3. Add new FTL strings to the local en-US repository
-------------------------------------------------
+----------------------------------------------------
 
 The changed (or brand new) FTL files from the patch need to be copied into the
 `en-US` repository. Remember that paths are slightly different, with
 localization repositories missing the :bash:`locales/en-US` portion. There’s no
 need to commit these changes locally.
 
 
 4. Run the migration recipe
--- a/taskcluster/docs/kinds.rst
+++ b/taskcluster/docs/kinds.rst
@@ -538,17 +538,17 @@ Tasks used to compare pairs of Firefox b
 As of writing, this is mainly meant to be used in try builds, by editing
 taskcluster/ci/diffoscope/kind.yml for your needs.
 
 addon
 -----
 Tasks used to build/package add-ons.
 
 openh264-plugin
------
+---------------
 Tasks used to build the openh264 plugin.
 
 openh264-signing
 ----------------
 Signing for the openh264 plugin.
 
 webrender
 ---------
--- a/testing/marionette/doc/internals/listener.rst
+++ b/testing/marionette/doc/internals/listener.rst
@@ -1,2 +1,2 @@
 listener module
-============
+===============
--- a/testing/marionette/doc/internals/message.rst
+++ b/testing/marionette/doc/internals/message.rst
@@ -1,10 +1,10 @@
 message module
-=============
+==============
 
 Command
 -------
 .. js:autoclass:: Command
   :members:
 
 Message
 -------
--- a/testing/mozbase/docs/manifestparser.rst
+++ b/testing/mozbase/docs/manifestparser.rst
@@ -83,17 +83,17 @@ advantages:
   instance, we could mark certain tests as randomorange with a bug
   number, if it were desirable.
 
 * ability to have sane and well-defined test-runs. You can keep
   different manifests for different test runs and ``[include:]``
   (sub)manifests as appropriate to your needs.
 
 Manifest Format
-````````
+```````````````
 
 Manifests are .ini file with the section names denoting the path
 relative to the manifest:
 
 .. code-block:: text
 
     [foo.js]
     [bar.js]
--- a/testing/mozbase/docs/servingcontent.rst
+++ b/testing/mozbase/docs/servingcontent.rst
@@ -1,10 +1,10 @@
 Handling content for the browser
-==============================
+================================
 
 It's often necessary to handle data for the browser. This can be accomplished
 by using a local webserver or by setting up a proxy.
 
 .. toctree::
    :maxdepth: 2
 
    mozhttpd
--- a/tools/lint/docs/linters/eslint-plugin-mozilla.rst
+++ b/tools/lint/docs/linters/eslint-plugin-mozilla.rst
@@ -242,17 +242,17 @@ a slight performance advantage by avoidi
 use-chromeutils-import
 ----------------------
 
 Require use of ``ChromeUtils.import`` and ``ChromeUtils.defineModuleGetter``
 rather than ``Components.utils.import`` and
 ``XPCOMUtils.defineLazyModuleGetter``.
 
 use-default-preference-values
----------------
+-----------------------------
 
 Require providing a second parameter to get*Pref methods instead of
 using a try/catch block.
 
 use-ownerGlobal
 ---------------
 
 Require .ownerGlobal instead of .ownerDocument.defaultView.