Add rudimentary support for aliases in ov #4408
Closed
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.
Fixes
Fixes #4407 by @sarayourfriend
cc @dhruvkb and @AetherUnbound who will be the most immediately interested in this
Description
This approach is similar to the associative array approach, but worse because we cannot easily look up an alias by its name, and there's no non-trivial way for aliases to stack (i.e., refer to another alias). We could do that by not breaking, and continuing to replace the first entry in the
args
array each time an expansion is encountered, but that would make alias expansion and cross-reference dependent on the order in which they're defined.This approach is also susceptible to coding errors, if the arrays are not an even number of entries, and it could be hard to debug that.
The Python alternative I've described in #4407 might be better in that regard. Implementing cross-referencing aliases would be trivial in Python (because we can use dicts) and there wouldn't be an ordering issue. It's also much harder to introduce a difficult to debug or non-obvious coding error with that approach.
I'll leave this as a draft and try the Python version to see which is better.
Testing Instructions
Try
ov j
,ov nuxt
, andov welcome
. Define your own aliases. See if you understand the approach, does it feel easy to use, or is it too complicated?Checklist
Update index.md
).main
) or a parent feature branch.just catalog/generate-docs
for catalogPRs) or the media properties generator (
just catalog/generate-docs media-props
for the catalog or
just api/generate-docs
for the API) where applicable.Developer Certificate of Origin
Developer Certificate of Origin