From 1871d966f48bfe322e281ffa3887baa4f198af6b Mon Sep 17 00:00:00 2001 From: john pfeiffer Date: Fri, 9 Sep 2016 10:32:39 -0700 Subject: [PATCH] Fix docstring urls for the API categories at consul.io --- consulate/__init__.py | 18 +++++++++--------- consulate/api/acl.py | 4 ++-- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/consulate/__init__.py b/consulate/__init__.py index ebe5480..c35d522 100644 --- a/consulate/__init__.py +++ b/consulate/__init__.py @@ -85,7 +85,7 @@ def __init__(self, @property def acl(self): """Access the Consul - `ACL `_ API + `ACL `_ API :rtype: :py:class:`consulate.api.acl.ACL` @@ -95,7 +95,7 @@ def acl(self): @property def agent(self): """Access the Consul - `Agent `_ API + `Agent `_ API :rtype: :py:class:`consulate.api.agent.Agent` @@ -105,7 +105,7 @@ def agent(self): @property def catalog(self): """Access the Consul - `Catalog `_ API + `Catalog `_ API :rtype: :py:class:`consulate.api.catalog.Catalog` @@ -115,7 +115,7 @@ def catalog(self): @property def event(self): """Access the Consul - `Events `_ API + `Events `_ API :rtype: :py:class:`consulate.api.event.Event` @@ -125,7 +125,7 @@ def event(self): @property def health(self): """Access the Consul - `Health `_ API + `Health `_ API :rtype: :py:class:`consulate.api.health.Health` @@ -135,7 +135,7 @@ def health(self): @property def kv(self): """Access the Consul - `KV `_ API + `KV `_ API :rtype: :py:class:`consulate.api.kv.KV` @@ -145,7 +145,7 @@ def kv(self): @property def lock(self): """Wrapper for easy :class:`~consulate.api.kv.KV` locks. - + `Semaphore ` _Guide Example: .. code:: python @@ -165,7 +165,7 @@ def lock(self): @property def session(self): """Access the Consul - `Session `_ API + `Session `_ API :rtype: :py:class:`consulate.api.session.Session` @@ -175,7 +175,7 @@ def session(self): @property def status(self): """Access the Consul - `Status `_ API + `Status `_ API :rtype: :py:class:`consulate.api.status.Status` diff --git a/consulate/api/acl.py b/consulate/api/acl.py index 0e0d202..9b991df 100644 --- a/consulate/api/acl.py +++ b/consulate/api/acl.py @@ -29,8 +29,8 @@ def create(self, name, acl_type='client', rules=None): the create endpoint. ``rules`` is a HCL string defining the rule policy. See - `https://consul.io/docs/internals/acl.html`_ for more information on - defining rules. + `Internals on `_ ACL + for more information on defining rules. The call to create will return the ID of the new ACL.