fix(clover): fix doc links for nested props #5508
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
Dependency Review✅ No vulnerabilities or OpenSSF Scorecard issues found.OpenSSF Scorecard
Scanned Files |
jkeiser
force-pushed
the
jkeiser/fix-doc-refs
branch
from
9f2c23d to
292b603
Compare
jkeiser
changed the base branch from
clover/remove-impossible-actions
to
main
sprutton1
reviewed
Feb 19, 2025
| @@ -576,6 +576,7 @@ export type DefaultPropType = "domain" | "secrets" | "resource_value"; | |||
| export function createObjectProp( | |||
| name: string, | |||
| parentPath: string[], | |||
| cfProp: CfObjectProperty | undefined, | |||
There was a problem hiding this comment.
What's the advantage of declaring cfProp this way instead of cfProp?: CfObjectProperty?
There was a problem hiding this comment.
Oh, I did it this way so that typescript would yell at me anywhere I tried to call createObjectProp() without a cfProp argument--it forced me to make a decision in each place we create an object prop. It's not as necessary now that that initial turn is done, but doesn't hurt to show the explicit decision in the code IMO.
There was a problem hiding this comment.
i.e. if you don't use ?, then you can pass undefined but you can't omit the parameter.
vbustamante
previously approved these changes
Feb 20, 2025
sprutton1
previously approved these changes
Feb 20, 2025
jkeiser
force-pushed
the
jkeiser/fix-doc-refs
branch
from
292b603 to
2282328
Compare
vbustamante
approved these changes
Feb 20, 2025
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.
This fixes the doc links we create for props that are part of nested definitions. In Cloud Formation, nested object definitions are placed in their own pages.
We had code trying to make this work, but it relied on
$ref, which is stripped from most props during dereferencing. This code populates a "defName" into every prop with the name of its containing definition before the dereferencing happens.Testing