-
Notifications
You must be signed in to change notification settings - Fork 2.8k
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
Use uppercase methods in README #272
Conversation
I tried to find the GitHub CLA on the interwebs, but couldn't find it. If someone sends me a link I can get that signed. |
HTTP methods are case-sensitive. The examples in the README currently lead developers to think that this API normalizes all of the method names to uppercase, leading to issues like JakeChampion#37 and JakeChampion#254. Setting the right precedent in the README will prevent developers from making mistake of trying to use method: 'patch' (or any other verb that isn't normalized for backwards compatibility).
076b85f
to
1d19130
Compare
I think that is here: https://cla.github.com |
Thanks @DasHaus ! Now I'm really embarrassed. I can't figure out how to sign the thing on the page. I thought maybe there was a JavaScript timer on the page hiding the accept button for a minute, but it's not sending over any JS. I'm wondering if this empty div is where the sign button is supposed to show up? |
Oh, figured it out! I needed to click through to the CLA from the failed PR status. Kinda weird, but hey, I figured it out ✌️ |
The case of I continue to hope for a |
@dgraham I, too, share a vision with you for patch! But alas, it may be some time before we get there. In the meantime, I think we have a responsibility to do what we can to prevent developers from spending time figuring out why (seemingly arbitrary) HTTP verbs don't work with this library. I think it's a problem that the README sets developers up to fail right now. If they're like me, they might copy + paste an example, then modify it for their own request. Unfortunately, nothing in the README explains the important detail that only some of the verbs are normalized. It's clear from those two issues (#37 and #254) – and my own experience – that some updated documentation could do some good here. Would you be open to a PR that adds a note about case sensitivity to the README? |
Thanks @dgraham 👍 |
@dgraham , thanks, yo ✌️ |
🎉 Thanks @dgraham ❤️ |
HTTP methods are case-sensitive. The examples in the README currently
lead developers to think that this API normalizes all of the method
names to uppercase, leading to issues like #37 and #254.
Setting the right precedent in the README will prevent developers
from making mistake of trying to use method: 'patch' (or any
other verb that isn't normalized for backwards compatibility).