Always use double quotes for comments #177
Closed
+105
−105
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
|
I don't think this is a good idea for the reasons given. Editing in anything that does a CSV export will not be able to reproduce this rule around a subset of the fields in the file. It COULD enclose all fields in double quotes though. No matter what, there is the possibility of messing things up when editing manually. I would suggest to leave it as it is. |
|
Agreed to not implement/enforce |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When trying to fix double quotes in a comment (5a35c10), I noticed that the CSV with comments for each term (https://github.com/tdwg/dwc/blob/use-quotes/build/config/terms.csv) only uses double quotes for the comment when necessary (e.g. when there was a comma in the comment).
I think this can lead to problems if the file is edited manually: introducing a comma in the comment field would break the csv. This pull requests adds quotes for all comments. It does not affect the guide and the CSV is now rendered correctly on GitHub: https://github.com/tdwg/dwc/blob/8fabcf056b9eb30fe08b8169bef25bdcbc3f40c9/build/config/terms.csv
Note 1: I wonder what will happen if this file is imported and exported in Google Refine though. Will quotes be stripped again?
Note 2: If this PR is not accepted, 5a35c10 still needs to be fixed in some way.