Add the ability to describe input filters #77
Open
datapimp wants to merge 1 commit intocypriss:masterfrom
Open
Add the ability to describe input filters #77datapimp wants to merge 1 commit intocypriss:masterfrom
datapimp wants to merge 1 commit intocypriss:masterfrom
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
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 is a minor enhancement to the filter configuration DSL that allows for developers to provide a brief human readable description of the filter / argument for the command.
In large projects which have a lot of commands, the ability to generate API documentation for those commands is very nice and the mutations gem already allows for a great level of introspection and so this is a natural extension of that.
Previously I solved this by adding the 'description' key to the filter options, but I like this approach as inline documentation becomes more of a first class citizen.
With this API in place you can inspect via:
CreateBook.input_descriptions