Inappropriate function docstrings
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
python-keystoneclient |
Fix Released
|
Low
|
Jamie Lennox |
Bug Description
There are inappropriate docstrings for the below functions.
1. keystoneclient/
def get_urls(self, attr=None, filter_value=None,
"""Fetch endpoint urls from the service catalog.
Fetch the endpoints from the service catalog for a particular
endpoint attribute. If no attribute is given, return the first
endpoint of the specified type.
:param string attr: Endpoint attribute name.
:param string filter_value: Endpoint attribute value.
:param string service_type: Service type of the endpoint.
:param string endpoint_type: Type of endpoint.
:param string region_name: Region of the endpoint. --> NOT NEEDED
:returns: tuple of urls or None (if no match found)
"""
2. keystoneclient/
def safe_encode(text, incoming=None,
"""Encodes incoming str/unicode using `encoding`.
If incoming is not specified, text is expected to be encoded with
current python's default encoding. (`sys.getdefaul
:param incoming: Text's current encoding
:param encoding: Expected encoding for text (Default UTF-8)
:param errors: Errors handling policy. See here for valid
values http://
:returns: text or a bytestring `encoding` encoded -- MISSING INFO FOR PARAMETER "text"
:raises TypeError: If text is not an isntance of str
"""
3. Similarly for func "def safe_decode"
Changed in python-keystoneclient: | |
assignee: | nobody → Shree Duth Awasthi (shreeduth-awasthi) |
Changed in python-keystoneclient: | |
importance: | Undecided → Low |
Changed in python-keystoneclient: | |
status: | Fix Committed → In Progress |
assignee: | Shree Duth Awasthi (shreeduth-awasthi) → Jamie Lennox (jamielennox) |
Changed in python-keystoneclient: | |
milestone: | none → 0.4.2 |
Changed in python-keystoneclient: | |
status: | Fix Committed → Fix Released |
Making the bug as committed as it will be fixed with " https:/ /review. openstack. org/#/c/ 49106/
Details at https:/ /review. openstack. org/#/c/ 59721/
Thanks.