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

update usage docs (#1270) #1273

Merged
merged 3 commits into from Apr 26, 2021
Merged

update usage docs (#1270) #1273

merged 3 commits into from Apr 26, 2021

Conversation

gurgeous
Copy link
Contributor

Took a stab at rewriting the Usage page. Changes include:

  1. showing method signatures for HTTP verbs
  2. give an overview of adapters & middleware
  3. explain a bit more about the shortcut methods vs. creating a connection
  4. use httpbingo.org instead of the defunct sushi.com
  5. quick note about the default connection and url encoding

I have no ego about this change, feedback is appreciated.

Copy link
Member

@olleolleolle olleolleolle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are wonderful changes, thank you!

When I read "resp" I thought I'd like the full word to be in the variable name, and when I read "bacon" I thought that we could spell it out fully as "chunky bacon" in order to honour _why the lucky stiff properly.

(But those are minor quibbles, easily changed later, if ever.)

I am glad we got to here: you filed an issue which became a discussion, which opened our eyes to starting troubles which could trip first-time users. And, now you have them covered, with this very-valuable PR.

@gurgeous
Copy link
Contributor Author

Aww, thank you for the kind words! Happy to help. We all gotta stick together in our little community.

@olleolleolle olleolleolle merged commit a582495 into lostisland:main Apr 26, 2021
@olleolleolle
Copy link
Member

@gurgeous Thanks again!

♥️ 💛 💚 💙 💜

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