openstack/swift
Code Issues Proposed changes

Fix warning while building docs

Browse Source 
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
This commit is contained in:
Tim Burke 2018-08-23 11:11:50 -07:00
parent f0472f1f79
commit e547448e96
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/overview_policies.rst
View File

@ -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.