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

Update External-Commands docs for new command abstraction #17139

Merged
merged 2 commits into from Apr 24, 2024
Merged

Conversation

dduugg
Copy link
Sponsor Member

@dduugg dduugg commented Apr 23, 2024

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes? Here's an example.
  • Have you successfully run brew style with your changes locally?
  • Have you successfully run brew typecheck with your changes locally?
  • Have you successfully run brew tests with your changes locally?

Copy link
Contributor

@apainintheneck apainintheneck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to communicate that the old way of defining a command is valid for now?

docs/External-Commands.md Outdated Show resolved Hide resolved
Co-authored-by: Kevin <apainintheneck@gmail.com>
@MikeMcQuaid
Copy link
Member

Do we need to communicate that the old way of defining a command is valid for now?

I don't think so. We don't really want new commands created that way.

@MikeMcQuaid
Copy link
Member

It might make sense to mention that args is available in all instance methods too.

Doing this in a follow-up PR would be nice 👍🏻

Copy link
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks again @dduugg!

@MikeMcQuaid MikeMcQuaid merged commit 378c71d into master Apr 24, 2024
25 checks passed
@MikeMcQuaid MikeMcQuaid deleted the cmd-docs branch April 24, 2024 07:49
@dduugg
Copy link
Sponsor Member Author

dduugg commented Apr 24, 2024

Do we need to communicate that the old way of defining a command is valid for now?

I don't think so. We don't really want new commands created that way.

That's my thinking. I intend to add deprecation warnings once i've updated commands in various taps.

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

3 participants