Expand route documentation in the README #1923
Merged
Conversation
This file contains 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 adds some more documentation, that was partly implicitly covered by the Basic Usage example but partly was only to be got by the method documentation. As this is an essential part of the DSL this it added for the new users conveniance.
Here's an example of a CHANGELOG.md entry: * [#1923](https://github.com/ruby-grape/grape/pull/1923): Expand route documentation in the readme - [@wdspkr](https://github.com/wdspkr).Generated by 🚫 danger |
|
Don't worry about danger. |
|
Sorry, misclicked. 😄 |
dblock
reviewed
Oct 25, 2019
README.md
Outdated
| get 'status' do | ||
| end | ||
|
|
||
| # is the same as (!) |
There was a problem hiding this comment.
I wanted to somehow raise attention that this will not result in a route parameter. But that was probably too subtle so I now extended the example.
Is this better now?
|
LGTM, merged |
basjanssen
pushed a commit
to basjanssen/grape
that referenced
this pull request
Feb 28, 2020
This adds some more documentation, that was partly implicitly covered by the Basic Usage example but partly was only to be got by the method documentation. As this is an essential part of the DSL this it added for the new users convenience.
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 adds some more documentation, that was partly implicitly covered
by the Basic Usage example but partly was only to be got by the method
documentation. As this is an essential part of the DSL this it added for
the new users conveniance. At least I was missing the info.
This is my first draft, so please tell me whether I'm missing something, or got something wrong!