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

further emphasize strikethrough formatting for errors in extant versions #122

Closed
ctb opened this issue Feb 5, 2019 · 3 comments
Closed
Assignees

Comments

@ctb
Copy link

ctb commented Feb 5, 2019

I love the paragraph on Sci-Hub error correction - am I correct in understanding that the link to the erroneous version of the pub was updated with a version that clearly highlighted the text as erroneous? this is really important if so, and has massive implications for the future of scholarly docs!

(and, out of curiousity, how do you do this with links that have a hash in them, or did I misunderstand? I can investigate this myself once I have a better network connection)

@dhimmel
Copy link
Contributor

dhimmel commented Feb 5, 2019

Quoting the relevant manuscript section:

Since its creation to facilitate the Deep Review, Manubot has been used to write a variety of scholarly documents. The Sci-Hub Coverage Study — performed openly on GitHub from its inception — investigated Sci-Hub’s repository of pirated articles [34]. Sci-Hub reviewed the initial preprint from this study in a series of tweets, pointing out a major error in one of the analyses. Within hours, the authors used Markdown’s strikethrough formatting in Manubot to cross-out the errant sentences (commitversioned manuscript), thereby alerting readers to the mistake and preventing further propagation of misinformation. One month later, a larger set of revisionsexplained the error in more detail and was included in a second version of the preprint. As such, continuous publishing via Manubot helped the authors address the error without delay, while retaining a public version history of the process.

@ctb the strikethrough formatting is not retroactive. None of the manuscript versions prior to the commit with the strikethrough changed. However, once the commit was deployed via GitHub Pages in greenelab/scihub-manuscript@b3db283, the latest version of the manuscript immediately showed the strikethrough as shown here:

image

It would be possible to manually edit the HTML of the past versions on the gh-pages branch to add the strikethrough. However, this is not something we recommend, as we think it's of utmost importance that the permalinks continue to refer to the same manuscript. Editing versioned manuscript.html files on gh-pages would also mean that the commit hash used as the version is no longer fully sufficient to create that output. On the other hand, the record of how this happened would be preserved and accessible, so perhaps it could be justifiable in some situations.

Should one need to alert viewers of past versions to critical mistakes, I'd recommend leaving Hypothesis annotations / highlights.

am I correct in understanding that the link to the erroneous version of the pub was updated with a version that clearly highlighted the text as erroneous?

It should be clear, but the the manuscripts at versioned links did not change. However, the latest manuscript, which appears at https://greenelab.github.io/scihub-manuscript/ or https://greenelab.github.io/scihub-manuscript/v/latest did update with the strikethrough.

@ctb
Copy link
Author

ctb commented Feb 7, 2019

ok, thank you for the thoughts! matches my understanding of the tech involved! please feel free to close this issue unless you want to revisit the text in the paper.

@agitter
Copy link
Collaborator

agitter commented Mar 22, 2019

@dhimmel can you please copy part of this discussion into the response to reviewers and reference this issue so that the other reviewers and editor can follow along? Feel free to edit the manuscript text as needed too.

dhimmel added a commit to dhimmel/meta-review that referenced this issue Mar 22, 2019
dhimmel added a commit to dhimmel/meta-review that referenced this issue Mar 22, 2019
dhimmel added a commit that referenced this issue Mar 22, 2019
agitter pushed a commit that referenced this issue Mar 22, 2019
This build is based on
d4a642e.

This commit was created by the following Travis CI build and job:
https://travis-ci.org/greenelab/meta-review/builds/510123261
https://travis-ci.org/greenelab/meta-review/jobs/510123262

[ci skip]

The full commit message that triggered this build is copied below:

Respond to review on Sci-Hub study strikethrough

Merges #175
Closes #122
agitter pushed a commit that referenced this issue Mar 22, 2019
This build is based on
d4a642e.

This commit was created by the following Travis CI build and job:
https://travis-ci.org/greenelab/meta-review/builds/510123261
https://travis-ci.org/greenelab/meta-review/jobs/510123262

[ci skip]

The full commit message that triggered this build is copied below:

Respond to review on Sci-Hub study strikethrough

Merges #175
Closes #122
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