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

Switch to tags in Intro Section #335

Closed
wants to merge 9 commits into from
Closed

Switch to tags in Intro Section #335

wants to merge 9 commits into from

Conversation

blengerich
Copy link
Contributor

Transfer from in-line doi or arxiv references to internal tags.

@dhimmel
Copy link
Collaborator

dhimmel commented Apr 21, 2017

@agitter and @blengerich the reason I prefer inline references to tags is that tags introduce a lot more room for error. In order for a tag reference to work, you must do multiple things correctly (across multiple files). The difficulty in doing multiple things correctly is evidenced by the commit history of this PR.

Additionally tags create a lookup burden for anyone who's not familiar with the study. You can't immediately go to the cited work, you have to look it up in tags.tsv. Also with multiple people editing tags.tsv at once, conflicts will become more frequent.

Not that we shouldn't merge this PR, but I caution you from going too far down the tag rabbit hole.

@blengerich
Copy link
Contributor Author

Your points make sense, especially with the errors in this PR commit history 😄. The choice of style doesn't make a big difference to me - I just had a few minutes and figured I could help out a little in case we did end up going with the tag style. Maintainers, please feel free to close this PR if desired.

@agitter
Copy link
Collaborator

agitter commented Apr 21, 2017

Should we be open-ended about tags versus inline for individual sub-sections, which are primarily written and edited by one person, but not encourage tags globally?

I'm hesitant to edit the intro in particular right now because we need to resolve #246. I just noticed to converting to tags in Treat introduced conflicts in my #313 so we may want to hold off further widespread tag conversion.

@blengerich
Copy link
Contributor Author

Sounds reasonable. I will close this PR and it can be reopened later if desired.

@blengerich blengerich closed this Apr 21, 2017
@dhimmel
Copy link
Collaborator

dhimmel commented Apr 21, 2017

Should we be open-ended about tags versus inline for individual sub-sections, which are primarily written and edited by one person, but not encourage tags globally?

I'm inclined to let authors do what they like... but we shouldn't give off the impression that tags are the preferred approach. I think tags make sense when the reference is unwieldy, like an ugly URL or long disgusting DOI that has no human readable portions. Or potentially if you're repeatedly referencing the same thing. But in general, the tag is more trouble than its worth (IMO).

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

Successfully merging this pull request may close these issues.

3 participants