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

Add API docs for commands API #217

Merged
merged 1 commit into from
Aug 21, 2020
Merged

Add API docs for commands API #217

merged 1 commit into from
Aug 21, 2020

Conversation

AlMcKinlay
Copy link
Member

Forgot to add this when I added the functionality a few months ago.

@AlMcKinlay
Copy link
Member Author

Ah no, there's a mistake in this.

@AlMcKinlay
Copy link
Member Author

Ok, I have removed the info about the runAsUser command on the Commands API because I realised it doesn't even work right now, and even if it did, it's kinda pointless because you need to pass through the client, which if you had you could just call runAsUser on the client itself.

So I'm going to fix that in another thing and then put the docs up for it.

@xPaw
Copy link
Member

xPaw commented Oct 2, 2019

Can you add explanation for what the callback arguments are? function(client, target, command, args)

@AlMcKinlay
Copy link
Member Author

Done. I also added docs for the client object as a separate page, because:

  1. It'll get too messy if that's in the same page
  2. I'm sure we'll use client elsewhere as well

@xPaw
Copy link
Member

xPaw commented Jul 21, 2020

I merged #220, can you review this PR please.

@AlMcKinlay
Copy link
Member Author

Most of this was included in #220, but there was 1 error that I've fixed for this PR.

@xPaw xPaw merged commit 9c6a9e4 into master Aug 21, 2020
@xPaw xPaw deleted the command-docs branch August 21, 2020 10:21
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