Skip to content

Fix readme tutorial link#2961

Merged
orbeckst merged 2 commits intoMDAnalysis:developfrom
IAlibay:fix-readme-link
Sep 30, 2020
Merged

Fix readme tutorial link#2961
orbeckst merged 2 commits intoMDAnalysis:developfrom
IAlibay:fix-readme-link

Conversation

@IAlibay
Copy link
Copy Markdown
Member

@IAlibay IAlibay commented Sep 30, 2020

I noticed the README.rst link for tutorials was broken.

Turns out that combining bold + reference is a non-trivial thing: https://docutils.sourceforge.io/FAQ.html#is-nested-inline-markup-possible.

It didn't seem immediately clear to me that bolding the tutorials link was necessary, so I just removed it. If we want to keep it I'll add in a substitution definition.

Changes made in this Pull Request:

  • Fix the link for tutorials in README.rst

PR Checklist

  • Tests? N/A
  • Docs? N/A
  • CHANGELOG updated? N/A
  • Issue raised/referenced? N/A

@codecov
Copy link
Copy Markdown

codecov bot commented Sep 30, 2020

Codecov Report

Merging #2961 into develop will decrease coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #2961      +/-   ##
===========================================
- Coverage    93.05%   93.03%   -0.02%     
===========================================
  Files          186      186              
  Lines        24609    24607       -2     
  Branches      3187     3181       -6     
===========================================
- Hits         22900    22894       -6     
- Misses        1661     1665       +4     
  Partials        48       48              
Impacted Files Coverage Δ
coordinates/base.py 94.63% <0.00%> (-0.50%) ⬇️
util.py 89.45% <0.00%> (-0.02%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9b88b83...50111cc. Read the comment docs.

Copy link
Copy Markdown
Member

@orbeckst orbeckst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@orbeckst orbeckst merged commit 108f1c2 into MDAnalysis:develop Sep 30, 2020
@IAlibay IAlibay deleted the fix-readme-link branch September 30, 2020 22:06
PicoCentauri pushed a commit to PicoCentauri/mdanalysis that referenced this pull request Mar 30, 2021
* Update README.rst
* Remove bolding from tutorials (does not work as a reST link)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants