Don't delete API docs for class aliases #815
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
frankharkins
approved these changes
Feb 15, 2024
Comment on lines
+38
to
+44
| const unsortedMembers = resultsWithName.filter( | ||
| (result) => | ||
| includes(["method", "property", "attribute"], result.meta.apiType) && | ||
| result.meta.apiName?.startsWith(`${clazz.meta.apiName}.`), | ||
| ); | ||
| unsortedMembers.forEach((result) => mergedMemberUrls.add(result.url)); | ||
| const members = orderBy(unsortedMembers, (result) => result.meta.apiName); |
There was a problem hiding this comment.
Nice code, I find this new form a lot easier to read.
To check I understand: The logic change is we're no longer adding function API types to members, and we're keeping track of which members have been merged?
There was a problem hiding this comment.
That's correct. I don't know why we were looking for functions before - they never are members of a class. In practice, it made no difference if we included them or not.
Comment on lines
-97
to
-100
| // remove merged results | ||
| const finalResults = reject(results, (result) => | ||
| includes(["method", "attribute", "property"], result.meta.apiType), | ||
| ); |
There was a problem hiding this comment.
This is where the pages were being deleted because we were assuming certain apiTypes were merged. Now we just check if they're in mergedMemberUrls.
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
Part of Qiskit#814. We shouldn't be deleting attribute pages if they don't correspond to an owning class. This PR also runs `npm run regen-apis`; as shown, this PR's logic change only impacts Qiskit v1 docs.
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.
Part of #814. We shouldn't be deleting attribute pages if they don't correspond to an owning class.
This PR also runs
npm run regen-apis; as shown, this PR's logic change only impacts Qiskit v1 docs.