Fix several broken links in Markdown files - #8311
Conversation
This PR simply replaces some broken hyperlinks in a small number of Markdown files.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8311 +/- ##
=======================================
Coverage 99.59% 99.59%
=======================================
Files 1125 1125
Lines 103250 103250
=======================================
Hits 102829 102829
Misses 421 421 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
| * Similarly, symbols in vendor packages, like [cirq-google](https://quantumai.google/reference/python/cirq_google/all_symbols), [cirq-aqt](https://quantumai.google/reference/python/cirq_aqt/all_symbols) are also not covered by the compatibility guarantee. | ||
| * If a symbol is available through the `cirq` Python module or its submodules, but is not documented, then it is **not** considered part of the public API. | ||
|
|
||
| <a name="what-is-not-covered"></a> |
There was a problem hiding this comment.
The auto-generated anchor seems to be the same. Please remove.
There was a problem hiding this comment.
The auto-generated anchor seems to be the same. Please remove.
Actually, it was hand-generated. I added after finding that markdown link checkers flagged the earlier reference in the file (#what-is-not-covered) as not found. I think it's because the emphasis text in the header (_not_) causes Markdown processors to create a different link than #what-is-not-covered.
Alternatively, I could change the _not_ to plain not and avoid the problem.
There was a problem hiding this comment.
By auto-generated I meant that if I visit https://github.com/quantumlib/Cirq/blob/main/docs/dev/versions.md and hover the mouse over that section heading, the browser shows the same anchor. In other words, GitHub already interprets that heading as having the #what-is-not-covered anchor.
Sure, changing to plain "not" will probably appease the checkers.
pavoljuhas
left a comment
pavoljuhas
left a comment
There was a problem hiding this comment.
Please see the inline comment before merge.
Thank you for correcting these!
pavoljuhas
added
the
ci/no-release
2 participants
This PR simply replaces some broken hyperlinks in a small number of Markdown files.