Fix examples link in README.md #2242
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It is currently pointing to our docs homepage rather than the examples section.
jordandsullivan
added
documentation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @jordandsullivan, thank you for submitting a PR to Mitiq! We will respond as soon as possible, and if you have any questions in the meantime, you can ask us on the Unitary Fund Discord.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2242 +/- ##
=======================================
Coverage 98.28% 98.28%
=======================================
Files 90 90
Lines 4257 4257
=======================================
Hits 4184 4184
Misses 73 73 ☔ View full report in Codecov by Sentry. |
The link in like 1305 of the CHANGELOG ([unitaryHACK](https://unitaryfund.github.io/unitaryhack/)!) failed to resolve in the docs build (https://github.com/unitaryfund/mitiq/actions/runs/8425856701/job/23072890372#step:6:1040). Link has now been updated to reflect the new domain for the 2021 unitaryhack website.
* Update unitaryhack link in Changelog to 2021 website
|
Thanks @jordandsullivan! |
cosenal
pushed a commit
that referenced
this pull request
Jun 26, 2024
* Fix examples link in README.md It is currently pointing to our docs homepage rather than the examples section. * Update AUTHORS * Update link to unitaryHACK in CHANGELOG.md (#2243) The link in like 1305 of the CHANGELOG ([unitaryHACK](https://unitaryfund.github.io/unitaryhack/)!) failed to resolve in the docs build (https://github.com/unitaryfund/mitiq/actions/runs/8425856701/job/23072890372#step:6:1040). Link has now been updated to reflect the new domain for the 2021 unitaryhack website. * Update link to 2021 unitaryHACK in CHANGELOG.md (#2246) * Update unitaryhack link in Changelog to 2021 website
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Under the Calibration section, it says "See our guides and examples for more explanation, techniques, and benchmarks." but the link to examples is currently pointing to our docs homepage (https://mitiq.readthedocs.io/) rather than the examples section (https://mitiq.readthedocs.io/en/stable/examples/examples.html). Simple update.
Second update was to the unitaryHack link, pointing it to the updated 2021 link in the changelog.
Description
License
Before opening the PR, please ensure you have completed the following where appropriate.