Skip to content

Commit 60d3e12

Browse files
author
Kevin D Smith
authored
Merge pull request #66 from Carus11/patch-1
Documentation: change userid to username
2 parents b0721d3 + afa2eb8 commit 60d3e12

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

doc/source/getting-started.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,21 @@ system administrator on how to acquire an account.
1717

1818
To connect to a CAS server, you simply import SWAT and use the :class:`swat.CAS` class
1919
to create a connection. This has a couple of different forms. The most
20-
basic is to pass the hostname, port, userid, and password.
20+
basic is to pass the hostname, port, username, and password.
2121

2222
.. ipython:: python
2323
:suppress:
2424
2525
import os
2626
host = os.environ['CASHOST']
2727
port = os.environ['CASPORT']
28-
userid = os.environ.get('CASUSER', None)
28+
username = os.environ.get('CASUSER', None)
2929
password = os.environ.get('CASPASSWORD', None)
3030
3131
.. ipython:: python
3232
3333
import swat
34-
conn = swat.CAS(host, port, userid, password)
34+
conn = swat.CAS(host, port, username, password)
3535
3636
However, if you are using a REST connection to CAS, a URL is the more natural
3737
way to specify a host, port, and protocol.
@@ -40,9 +40,9 @@ way to specify a host, port, and protocol.
4040
:verbatim:
4141
4242
conn = swat.CAS('https://my-cas-host.com:443/cas-shared-default-http/',
43-
userid='...', password='...')
43+
username='...', password='...')
4444
45-
Notice that in the URL case, ``userid`` and ``password``, must be specified
45+
Notice that in the URL case, ``username`` and ``password``, must be specified
4646
as keyword parameters since the ``port`` parameter is being skipped. Also,
4747
in this case we are using a proxy server that requires the base path
4848
of 'cas-shared-default-http'. If you are connecting directly to a CAS

0 commit comments

Comments
 (0)