Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix typo from desc to describe #2373

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

isuvorov
Copy link

Probably left over from the previous API version

Probably left over from the previous API version
@shadowspawn
Copy link
Member

shadowspawn commented Nov 12, 2023

Did you find this did not work, or just that it did not match other documentation?

For historical reasons, I think desc or describe or description are all supported internally.

private extractDesc({describe, description, desc}: CommandHandlerDefinition) {

The "Command Module" documentation shows exports.describe although desc is also used in some examples. I think there is a move away from desc, so your change is an improvement.

There is one other similar reference to your change in the documentation, so I suggest change this one too:

desc: 'Set a config variable',

@isuvorov
Copy link
Author

isuvorov commented Nov 25, 2023

Did you find this did not work, or just that it did not match other documentation?

I just copied the example and catch a TypeScript type error.
You are right, if I ignore it everything works fine.

So I suggest change this one too

Agree with you
Done ✅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants