LibraryCarpentry / lc-open-refine

Library Carpentry: OpenRefine
https://librarycarpentry.org/lc-open-refine/
Other
52 stars 134 forks source link

Replace dashes with underscores #307

Open ndporter opened 1 year ago

ndporter commented 1 year ago

Following best practices (see TidyData lesson column headers being created should use _ instead of - whenever possible. This applies at least to Looking up Data (e.g., Journal-details) but other episodes should be checked as well for consistency.

ostephens commented 1 year ago

Great suggestion @ndporter - thank you 🙏

If anyone is willing / able to check through the lesson and identify any other examples, or even better make the edits for the maintainers to then approve that would be amazing.

This tutorial shows how you can show us the exact line and make the edit for maintainers to approve

ndporter commented 1 year ago

I won't have a chance to do this in the near future, or I would have put in a PR myself. I will also note that images may need to be changed to be consistent with the text (including the example I identified).

jas58 commented 1 year ago

I'll add a note to also make the hyphen in User-Agent an underscore.

And a question: Might this be an instructor note in addition to the text edits?

Also, what does the alt-text need to be? it is currently: Add column by fetching URLs screen capture

Does the alt-text need to describe what the image looks like (but doesn't need to repeat preceding or following instructions): "The preview panel should read Row 1's value is 1099-4300 and the third column shows the api.crossref address completed."

bencomp commented 1 year ago

I'll add a note to also make the hyphen in User-Agent an underscore.

If you meant the HTTP header: that should be a hyphen.

ndporter commented 1 year ago

Good catch @bencomp it's important to only change the column headers we create, not the data we're trying to pass through the API, whose structure is determined by the providers.

ostephens commented 1 year ago

Column names in "Looking up data" episode fixed by #310. Waiting on confirmation from @mahdi-robbani whether a review of all episodes was included in that work

ostephens commented 1 year ago

Confirmed that #310 only addresses the Looking up data episode, so there is still a task here to check if there are any column names that are not appropriately formatted in any other episodes

ostephens commented 1 year ago

Have added #314 for the user-agent/http header issue

ostephens commented 1 year ago

Remaining tasks for this issue: