search

alan-turing-institute / rds-course

Materials for Turing's Research Data Science course
https://alan-turing-institute.github.io/rds-course/
31 stars 13 forks source link

Update references to be more explicit? #116

Open AoifeHughes opened 1 year ago

AoifeHughes commented 1 year ago

References are difficult to link in text, this could become confusing for readers. For example in module 1.

https://github.com/alan-turing-institute/rds-course/blob/53c121a83c96cb8b92fa69e7ed7804a84b43e18e/coursebook/modules/m1/1.1-WhatIsDataScience.ipynb?short_path=6a11c01#L59

The use of Roger's name does not make it clear that they are being referenced formally.

https://github.com/alan-turing-institute/rds-course/blob/53c121a83c96cb8b92fa69e7ed7804a84b43e18e/coursebook/modules/m1/1.1-WhatIsDataScience.ipynb?short_path=6a11c01#L265

I can see two possible solutions to making references more explicit :

  1. Hyperlink to the existing references section when appropriate
  2. Use BibTeX https://github.com/takluyver/cite2c
    • This would be my preference, and I volunteer to experiment with this.
AoifeHughes commented 1 year ago

Did some digging - this seems more promising https://jupyter.brynmawr.edu/services/public/dblank/jupyter.cs/Examples/Calico%20Document%20Tools%20and%20Bibtex.ipynb