[Console] Add more examples for lazy commands #18664
Merged
Conversation
This file contains hidden or 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
javiereguiluz
approved these changes
Aug 9, 2023
chalasr
reviewed
Aug 12, 2023
chalasr
reviewed
Aug 12, 2023
|
Open to finalize this PR @theofidry ? |
theofidry
force-pushed
the
docs/lazy
branch
from
8ffe408 to
c1dc758
Compare
|
@OskarStark updated |
|
Can we merge this into the |
|
@xabbuh I do not know if all of that applies to 5.4, if that's the case sure |
OskarStark
reviewed
Oct 23, 2023
|
@chalasr do you know if 5.4 would be the right branch? |
|
ping @chalasr (upon his request) |
OskarStark
force-pushed
the
docs/lazy
branch
from
9366238 to
5f063a2
Compare
|
Thank you Théo. |
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.
I think the current doc is a bit confusing regarding the laziness of commands:
LazyCommandwhich is quite important to make a command lazy in a way it still works with thelistcommand which is used a lot.listdoc regarding instantiating the commands is a bit too absolute. Technically it is not wrong but there is also more subtleties to it. Indeed what it will really do is instantiate the command and then try to get the name and description. Which also means if the underlying command/factory can still not be instantiated (either by tweakingCommandor usingLazyCommand). This is unlike another command like the auto-complete or help which will try to get the input definition in which case even aLazyCommandwill call its command factory.I am not sure which branch it should target however and I am sure there is a lot to say about the phrasing used.