UDST / urbanaccess

A tool for GTFS transit and OSM pedestrian network accessibility analysis by UrbanSim
https://udst.github.io/urbanaccess/index.html
GNU Affero General Public License v3.0
236 stars 56 forks source link

Edit to variable name in documentation, headways() positional args #14

Closed kuanb closed 7 years ago

kuanb commented 7 years ago

In both the code and the documentation for urbanaccess.gtfs.load.gtfsfeed_to_df, the return variable is called gtfsfeeds_df.

This is a bit confusing as the appending of _df typically indicates that the variable is a dataframe. In this case, it is not - it is a dictionary containing dataframes. Perhaps a better name would be gtfsfeeds_dict or gtfsfeeds_dfs_dict.

This naming convention could also be carried over to urbanaccess.gtfs.headways.headways, where the parameter gtfsfeeds_df could be similarly renamed.

11:10 AM PST - Edit: In the above I refer to the response as a dictionary when I realize it is an object instantiated from the class described in this file. That said, some rename still would be very helpful in clarifying that it is not a dataframe.

sablanchard commented 7 years ago

Great point, would something like gtfsfeeds_dfs be sufficient?

kuanb commented 7 years ago

Yeah I think that would be helpful!

sablanchard commented 7 years ago

Great! Will make the change in a upcoming PR.

pksohn commented 7 years ago

Addressed with #17.