Is your feature request related to a problem? Please describe.
To further lower the barrier of entry it would be useful to better explain the nature of the data the user is working with.
Describe the solution you'd like
The following information should be added:
A high level, overall description of what the code does. For example, the user puts in some filtering details, it goes to BODS and obtains datasets (how do these relate to what the user searched for) and timetables - and saves them, where? In what format?
What is the minimum the user needs to do to get an output?
What will the user see as an output in the terminal?
The mention of XML files is somewhat confusing as this detail has been abstracted away from the user. Consider whether this should be referred to in the URL column in a data dictionary entry or whether it should be explained at a high level how the data extractor actually simplifies things i.e. saying using the API you might get multiple XML files per timetable, but with the data extractor these are combined into one easy-to-work-with extract - and the URL is supplied if you want to view the original XML
Is your feature request related to a problem? Please describe.
To further lower the barrier of entry it would be useful to better explain the nature of the data the user is working with.
Describe the solution you'd like
The following information should be added:
The mention of XML files is somewhat confusing as this detail has been abstracted away from the user. Consider whether this should be referred to in the URL column in a data dictionary entry or whether it should be explained at a high level how the data extractor actually simplifies things i.e. saying using the API you might get multiple XML files per timetable, but with the data extractor these are combined into one easy-to-work-with extract - and the URL is supplied if you want to view the original XML