From e547448e96e7a8b927839b18d5d3fae640b1bd27 Mon Sep 17 00:00:00 2001 From: Tim Burke Date: Thu, 23 Aug 2018 11:11:50 -0700 Subject: [PATCH] Fix warning while building docs Seen locally: Warning, treated as error: .../swift/doc/source/overview_policies.rst:555:more than one target found for cross-reference u'get_data_dir': swift.obj.reconstructor.get_data_dir, swift.obj.replicator.get_data_dir, swift.obj.diskfile.get_data_dir Not sure why it hasn't been seen in the gate... The whole sentence is suspect, though; the Diskfile class doesn't define a get_data_dir method, though it uses the module-level get_data_dir... Change-Id: I6855c82315e1c71596ecce25b66b54133c239377 --- doc/source/overview_policies.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/overview_policies.rst b/doc/source/overview_policies.rst index 11d509e16b..66dc5de212 100644 --- a/doc/source/overview_policies.rst +++ b/doc/source/overview_policies.rst @@ -561,7 +561,7 @@ included implementation of :class:`.Diskfile` lays out the directory structure described earlier but that's owned within :class:`.Diskfile`; external modules have no visibility into that detail. A common function is provided to map various directory names and/or strings based on their policy index. For example -:class:`.Diskfile` defines :func:`.get_data_dir` which builds off of a generic +:class:`.Diskfile` defines ``get_data_dir`` which builds off of a generic :func:`.get_policy_string` to consistently build policy aware strings for various usage.