Fix broken reST links in old changelogs #1207
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1207 +/- ##
=======================================
Coverage ? 96.98%
=======================================
Files ? 71
Lines ? 7030
Branches ? 0
=======================================
Hits ? 6818
Misses ? 212
Partials ? 0 Continue to review full report at Codecov.
|
Missed the fact that you've already done that! |
|
|
||
| .. _change-log-0.2.0-api: | ||
|
|
||
| Changes to API | ||
| -------------- | ||
|
|
||
| - Move `~plasmapy.transport` from `~plasmapy.physics` to its own | ||
| - Move ``plasmapy.transport`` from ``plasmapy.physics`` to its own |
docs/whatsnew/0.3.0.rst
Outdated
| to bug outlined in issue `<https://github.com/PlasmaPy/PlasmaPy/issues/726>`_. Associated pytests | ||
| are marked with `pytest.mark.xfails` and doctests are marked with `doctests: +SKIP`. (`#722 <https://github.com/plasmapy/plasmapy/pull/722>`__) | ||
| are marked with ``pytest.mark.xfails`` and doctests are marked with ``doctests: +SKIP``. (`#722 <https://github.com/plasmapy/plasmapy/pull/722>`__) |
There was a problem hiding this comment.
It's xfail, actually, and we just had a typo in here. But, whatever.
…-fixes This includes one additional typo fix.
This PR is a spin-off of #1206 in order to fix the warnings associated with broken reST links. I'm limiting the scope of this PR to fixing links, without making any substantive changes to the changelog otherwise. Thus far I've been able to get us from 1466 to 908 warnings.
My main motivation for this pull request is that we really ought to enable the nitpicky (
-n) option insphinx-buildin the documentation tests for each pull request. That way, we would be able to catch broken links before they make their way into the repository. Before we can enable that option...however...we have to fix the broken links that are currently in the documentation, which were largely concentrated in old changelogs as references to stuff that doesn't exist anymore.I removed the
|PhysicalType|substitution since it's in Astropy 4.3+ only, and because it's not used anywhere in PlasmaPy (yet).I also avoided using substitutions for code within PlasmaPy because the locations of objects sometimes changes with time, and the changelog should reflect the state of the repository at that time.