department-for-transport-BODS / bods-data-extractor

A python client for downloading and extracting data from the UK Bus Open Data Service
Other
44 stars 8 forks source link

Improve documentation code comments (3) #69

Open EOstridge opened 1 year ago

EOstridge commented 1 year ago

Is your feature request related to a problem? Please describe.

As a data consumer, it would be helpful to have more clarity in the code comments within the current documentation.

Describe the solution you'd like

Ensure comments and terminology are at the most accessible level possible, within the documentation code examples.

For example, within "How to extract Stop Level data" - one of the code comments is: "stop_level variable is a dictionary of dataframes". Saying a dictionary of dataframes may not mean much to someone new to python.

image

adamakram1 commented 1 year ago

Value(3)