From e6c2281c356cce9765bd31f7bb44c278c38c9866 Mon Sep 17 00:00:00 2001 From: Tim Millican Date: Wed, 17 Jun 2015 15:52:34 -0400 Subject: [PATCH] Add spaces around function params for browser to linewrap on The modified function names with parameter do not wrap on the webpage, due to not having a normal breakpoint (usually spaces). Including a space after the opening paren, as well as one before the closing paren to visually balance, seems to be the best option I can see for fixing this while still maintaining readability and coherence in the rst file itself. Closes-Bug: #1373110 Change-Id: Iea09ca21ff50a51bb28f518b0b124f129cf06ae2 --- doc/source/devref/plugin.spi.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/source/devref/plugin.spi.rst b/doc/source/devref/plugin.spi.rst index 703844a4..8f16f079 100644 --- a/doc/source/devref/plugin.spi.rst +++ b/doc/source/devref/plugin.spi.rst @@ -15,8 +15,8 @@ as well as configs and whatever else that plugin needs to create the Hadoop clus *Example return value*: [“1.2.1”, “2.3.0”, “2.4.1”] -get_configs(hadoop_version) -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +get_configs( hadoop_version) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Lists all configs supported by plugin with descriptions, defaults and targets for which this config is applicable. @@ -24,8 +24,8 @@ Lists all configs supported by plugin with descriptions, defaults and targets fo *Example return value*: ((“JobTracker heap size”, "JobTracker heap size, in MB", "int", “512”, `“mapreduce”`, "node", True, 1)) -get_node_processes(hadoop_version) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +get_node_processes( hadoop_version) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Returns all supported services and node processes for a given Hadoop version. Each node process belongs to a single service and that relationship is reflected in the returned dict object. @@ -35,8 +35,8 @@ See example for details. *Example return value*: {"mapreduce": ["tasktracker", "jobtracker"], "hdfs": ["datanode", "namenode"]} -get_required_image_tags(hadoop_version) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +get_required_image_tags( hadoop_version) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Lists tags, that should be added to OpenStack Image via Image Registry. Tags are used to filter Images by plugin and hadoop version.