Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

roadway: vars: refer to files by content rather than by format #19

Open
chunhochow opened this issue Aug 9, 2024 · 3 comments
Open
Assignees

Comments

@chunhochow
Copy link
Member

chunhochow commented Aug 9, 2024

copied from pull request #18 comment:

e.g. for variables such as excel_df or Excel_File_Path. or for dbf_files etc

when appropriate, refer to the file (also like in the parameter list) as what it is, rather than its format. What is this excel file?

the function argument excel_file can still say excel in some form, if it's important for the reader to know that one should pass in an excel file. but right now I don't know what is this file about. Suggest making it foobar_excel_filepath. (I assume it's a filepath. a file object and a filepath are different things so maybe making it clearer would be better)

but once it's been readed in, we don't have to care that it was read in from an excel file anymore, so we can just say foobar_df.

@chunhochow
Copy link
Member Author

chunhochow commented Aug 9, 2024

copied from pull request #18 comment:

for dbf_files (LOAD[TOD]_FINAL.dbf), we should name these as loaded_network_files (@sdrewc / @dantischler is this accurate?)
(in general, when possible, we want to say what the file is about, rather than the format (unless if the format is important)

this includes all the parts in the README that refers to these dbf files too

@sdrewc
Copy link
Member

sdrewc commented Aug 13, 2024

copied from pull request #18 comment:

for dbf_files (LOAD[TOD]_FINAL.dbf), we should name these as loaded_network_files (@sdrewc / @dantischler is this accurate?) (in general, when possible, we want to say what the file is about, rather than the format (unless if the format is important)

this includes all the parts in the README that refers to these dbf files too

@chunhochow I agree.

@chunhochow
Copy link
Member Author

Still some remaining variables to clean up after #18

@chunhochow chunhochow reopened this Oct 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants