Skip to content

Commit 7a4be2a

Browse files
committed
Update documentation for indicating URL format.
1 parent e452140 commit 7a4be2a

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

dokuwiki.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,11 @@ class DokuWiki(object):
123123
wiki = dokuwiki.DokuWiki('URL', 'USER', 'PASSWORD', cookieAuth=False)
124124
except (DokuWikiError, Exception) as err:
125125
print('unable to connect: %s' % err)
126+
127+
.. note::
128+
129+
The URL format is: `PROTO://FQDN[/PATH]` (*https://www.example.com/dokuwiki*
130+
for example).
126131
"""
127132

128133
def __init__(self, url, user, password, cookieAuth=False, **kwargs):

0 commit comments

Comments
 (0)