Skip to content

Commit 8c6c8fa

Browse files
committed
Add docstring
1 parent 42b8cc6 commit 8c6c8fa

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

django_mongodb/utils.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,13 @@ def check_django_compatability():
2727

2828

2929
def parse(uri):
30-
uri = parse_uri(str(uri))
30+
"""
31+
Parse a MongoDB URI and return a dictionary of Django database
32+
settings. This function is a wrapper around PyMongo's
33+
``pymongo.uri_parser.parse_uri()`` function that converts PyMongo's
34+
settings dictionary into a Django database settings dictionary.
35+
"""
36+
uri = parse_uri(uri)
3137

3238
host = None
3339
port = None

0 commit comments

Comments
 (0)