search

hasadna / open-bus

:bus: Analysing Israel's public transport data
93 stars 29 forks source link

Create "read the docs" documentation to create_siri_csv_splunk pipeline step #241

Open adiwaz opened 5 years ago

adiwaz commented 5 years ago

Create "read the docs" documentation for the module: create_siri_csv_splunk.py, which is responsible for parsing the raw SIRI data logs into table format that is pushed into splunk.

Docs should be in a similar format to the gtfs_stats docs created for issue #186 .
Docs should elaborate the API of this module, and specifically explain every data variable which is generated by the function "create_trip_df_v2".

Supplementary documentation about the source of SIRI data will be in a wiki page (see issue #### - to be updated soon), and in the siri_retriever code docs.

adiwaz commented 5 years ago

Update: work-in-progress docs in branch siri-stats-doc