Skip to content

Commit 202f55c

Browse files
committed
Updated docs
1 parent 430aea9 commit 202f55c

3 files changed

Lines changed: 15 additions & 19 deletions

File tree

docs/usage/functionality.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,4 @@ Module: configuration
2727

2828
.. automodule:: maproulette.api.configuration
2929
:members:
30-
:show-inheritance:
30+
:special-members:

docs/usage/getting_started.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,9 @@ Import the package:
1414
import maproulette
1515
1616
17-
From there, create a configuration object. Depending on your use case, you may need to pass your API key. Specify
18-
that when you create your configuration. For example:
17+
From there, create a configuration object. When creating the configuration you can specify a number of of parameters
18+
depending on your needs including the hostname, protocol, and client-side certificates. Depending on your use case, you
19+
may need to obtain and pass your API key as well. For example:
1920

2021
.. code-block:: python
2122

maproulette/api/configuration.py

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,17 @@ def __init__(self, hostname=DEFAULT_HOSTNAME, protocol=DEFAULT_PROTOCOL, api_ver
1111
api_key=None, certs=None, verify=True):
1212
"""Create a new configuration object to connect to the MapRoulette server.
1313
14-
:param hostname: Optional parameter to specify the hostname of the MapRoulette instance being addressed. Do not
15-
include the protocol (https, http). Default value is 'maproulette.org'.
16-
:type hostname: str
17-
:param protocol: Optional parameter to specify the protocol to use for the connection to the MapRoulette
18-
instance being addressed such as https or http. Default value is 'https'.
19-
:type protocol: str
20-
:param api_version: Optional parameter to specify the API version to use. The default is '/api/v2'.
21-
:type api_version: str
22-
:param api_key: Optional parameter to pass the user-specific API key. This key is necessary for some actions.
23-
:type api_key: str
24-
:param certs: Optional parameter to pass the client-side certificate and key if necessary to make connection
25-
with the MapRoulette instance being addressed.
26-
:type certs: tuple
27-
:param verify: Optional parameter to specify whether to verify SSL certificates for HTTPS requests. Default is
28-
True.
29-
:type verify: bool
14+
:param str hostname: Optional parameter to specify the hostname of the MapRoulette instance being addressed. Do
15+
not include the protocol (https, http). Default value is 'maproulette.org'.
16+
:param str protocol: Optional parameter to specify the protocol to use for the connection to the MapRoulette
17+
instance being addressed such as https or http. Default value is 'https'.
18+
:param str api_version: Optional parameter to specify the API version to use. The default is '/api/v2'.
19+
:param str api_key: Optional parameter to pass the user-specific API key. This key is necessary for some
20+
actions.
21+
:param tuple certs: Optional parameter to pass the client-side certificate and key if necessary to make
22+
connection with the MapRoulette instance being addressed.
23+
:param bool verify: Optional parameter to specify whether to verify SSL certificates for HTTPS requests. Default
24+
is True.
3025
"""
3126
self.api_url = f"{protocol}://{hostname}{api_version}"
3227
self.base_url = f"{protocol}://{hostname}"

0 commit comments

Comments
 (0)