Skip to content

Commit

Permalink
Fixed docstring warnings in connector and objects modules
Browse files Browse the repository at this point in the history
* Added intersphinx extension to reference external documentation.

* Updated code snippet in the EA.ea_dict function docstring.
  • Loading branch information
Alex Chernevskiy committed Aug 24, 2022
1 parent a2a99cc commit 5686ab3
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
6 changes: 6 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
'sphinx.ext.napoleon',
'sphinx.ext.intersphinx',
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -277,3 +278,8 @@

# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False

intersphinx_mapping = {
'python': ('https://docs.python.org/3', None),
'requests': ('https://requests.readthedocs.io/en/latest/', None)
}
4 changes: 2 additions & 2 deletions infoblox_client/connector.py
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ def get_object(self, obj_type, payload=None, return_fields=None,
A list of the Infoblox objects requested
Raises:
requests.exceptions.HTTPError: If API responded with error HTTP
status code.
status code.
"""
self._validate_obj_type_or_die(obj_type, obj_type_expected=False)

Expand Down Expand Up @@ -545,7 +545,7 @@ def is_cloud_wapi(wapi_version):
False otherwise.
Raises:
ValueError if an invalid version is passed
ValueError: if an invalid version is passed
"""
valid = wapi_version and isinstance(wapi_version, six.string_types)
if not valid:
Expand Down
2 changes: 1 addition & 1 deletion infoblox_client/objects.py
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ def __repr__(self):

@property
def ea_dict(self):
"""Returns dict with EAs in {ea_name: ea_value} format."""
"""Returns dict with EAs in ``{ea_name: ea_value}`` format."""
return self._ea_dict.copy()

@classmethod
Expand Down

0 comments on commit 5686ab3

Please sign in to comment.