-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
style: add line breaks to long lines
- Loading branch information
Showing
3 changed files
with
34 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,26 @@ | ||
Package Overview | ||
================ | ||
|
||
Interacting with `Data.gov.sg`_'s API is done through one of four clients, where each client corresponds with a "set" of endpoints. (`Data.gov.sg`_ doesn't categorise its endpoints by set, but it can be assumed from the endpoints' path directories.) | ||
Interacting with `Data.gov.sg`_'s API is done through one of four clients, | ||
where each client corresponds with a "set" of endpoints. (`Data.gov.sg`_ doesn't | ||
categorise its endpoints by set, but it can be assumed from the endpoints' path | ||
directories.) | ||
|
||
.. _Data.gov.sg: https://data.gov.sg | ||
|
||
The four clients are: ``Ckan``, ``Environment``, ``Technology`` and ``Transport``. | ||
|
||
Each client contains several public functions, one function per endpoint. A function's name is the same as its corresponding endpoint's ending path. | ||
Each client contains several public functions, one function per endpoint. A | ||
function's name is the same as its corresponding endpoint's ending path. | ||
|
||
Most functions accept named arguments, where an argument corresponds with a parameter that the endpoint accepts. | ||
Most functions accept named arguments, where an argument corresponds with a | ||
parameter that the endpoint accepts. | ||
|
||
*Why have separate clients instead of one single client?* | ||
|
||
Without knowing how `Data.gov.sg`_'s API will evolve, and noticing that the endpoints were themselves already partitioned into "sets", it seemed like a good idea to keep each set of endpoints in its own contextual client. This allows for each "set" of endpoints to be customised on their own, e.g. the ``Environment`` endpoints allow for either a date or date-time to be specified, whereas the ``Transport`` endpoints don't. | ||
Without knowing how `Data.gov.sg`_'s API will evolve, and noticing that the | ||
endpoints were themselves already partitioned into "sets", it seemed like a | ||
good idea to keep each set of endpoints in its own contextual client. This | ||
allows for each "set" of endpoints to be customised on their own, e.g. the | ||
``Environment`` endpoints allow for either a date or date-time to be | ||
specified, whereas the ``Transport`` endpoints don't. |