Add a function to search Phpactor RPC documentation #71
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
This patch provides an interactive function which will prompt the user for the name of one of Phpactor's RPC commands, and will proceed to open the user's browser to the documentation on that command. For the documentation we use the Phpactor GitHub page because it's Markdown document of RPC commands contains hyperlinks to each individual command. In the future we should probably restrict the possible inputs to only those command names which are valid. However, that assumes that `phpactor.el` has a built-in list of valid commands. If not, or if we decide we do not wish to maintain such a list, then we should not bother with this addition. Finally, this patch does not update the README with any mention of the new function as I could not think of a succinct way to describe it. Signed-off-by: Eric James Michael Ritz <ejmr@no.current.address>
Author
|
If you want to test this out, |
zonuexe
approved these changes
Sep 23, 2018
Member
|
@ejmr Thanks! |
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.
This patch provides an interactive function which will prompt the
user for the name of one of Phpactor's RPC commands, and will proceed
to open the user's browser to the documentation on that command.
For the documentation we use the Phpactor GitHub page because
it's Markdown document of RPC commands contains hyperlinks to each
individual command.
In the future we should probably restrict the possible inputs to
only those command names which are valid. However, that assumes that
phpactor.elhas a built-in list of valid commands. If not, or ifwe decide we do not wish to maintain such a list, then we should not
bother with this addition.
Finally, this patch does not update the README with any mention of
the new function as I could not think of a succinct way to describe it.
Signed-off-by: Eric James Michael Ritz ejmr@no.current.address