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

README feedback items #1

Closed
7 tasks done
pearsonca opened this issue Dec 5, 2018 · 0 comments
Closed
7 tasks done

README feedback items #1

pearsonca opened this issue Dec 5, 2018 · 0 comments
Assignees
Milestone

Comments

@pearsonca
Copy link

pearsonca commented Dec 5, 2018

Generally good README. Some notes, mostly concerning the README directly, but some with knock-on edits.

  • Data First link seems to be improperly formatted. Linking to that top level page seems insufficient guidance for asking about data access.
  • would be nice to have a link to description of data set itself (e.g., any publications? page on Data First devoted to this data set?)
  • "Setup Instructions" directions mildly imply that python 3 would be installed as part of cloning process.
  • directions say "Navigate to...dlr_data_retrieval", but the structure picture says "dlr_data"
  • for update cnxtnstr.txt, link to file itself in repository? Possible to make filling in that file easier? E.g. Server={REPLACE EVERYTHING WITHIN BRACES BY XX.YY.ZZ};
  • for start & end years: exclusive or inclusive?
  • command line convention: - should be used with single, lowercase letters. So recommend -c instead of -csv. The latter is read as combining the c, s, and v flags. Should be able to specify a long form option as --csv.
@wiebket wiebket self-assigned this Dec 7, 2018
@wiebket wiebket added this to the in progress milestone Dec 7, 2018
@wiebket wiebket closed this as completed May 6, 2019
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

2 participants