Don't check metadata for API docs by default #817
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
arnaucasau
reviewed
Feb 15, 2024
Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com>
arnaucasau
approved these changes
Feb 15, 2024
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
Closes Qiskit#793. This unblocks us starting to check API docs in Qiskit#66. It also speeds up the workflow for non-API docs, which is valuable because non-API and API docs have such different workflows. I only added an `--apis` argument rather than e.g. `--current-apis` vs `--historical-apis` because this check is fast enough to not need the nuance. --------- Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com>
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.
Closes #793.
This unblocks us starting to check API docs in #66. It also speeds up the workflow for non-API docs, which is valuable because non-API and API docs have such different workflows.
I only added an
--apisargument rather than e.g.--current-apisvs--historical-apisbecause this check is fast enough to not need the nuance.