Improve Client docs #727
Improve Client docs #727
Conversation
* Use suggestion in haskell-servant#606 to document pattern matching client behaviour better * Helpful suggestion of reading in order in the index * A couple of extra internal links * Fox some typos / punctuation. Fixes haskell-servant#606
|
LGTM |
doc/tutorial/Client.lhs
Outdated
| @@ -1,12 +1,11 @@ | |||
| # Querying an API | |||
|
|
|||
| While defining handlers that serve an API has a lot to it, querying an API is simpler: we do not care about what happens inside the webserver, we just need to know how to talk to it and get a response back. Except that we usually have to write the querying functions by hand because the structure of the API isn't a first class citizen and can't be inspected to generate a bunch of client-side functions. | |||
| While defining handlers that [serve an API](Server.lhs) has a lot to it, querying an API is simpler: we do not care about what happens inside the webserver, we just need to know how to talk to it and get a response back. Except that we usually have to write the querying functions by hand because the structure of the API isn't a first class citizen and can't be inspected to generate a bunch of client-side functions. | |||
There was a problem hiding this comment.
The original grammar wasn't quite correct. Perhaps while we're here: Replace "Except that..." with "The only exception is that..." and it will be correct.
There was a problem hiding this comment.
Hmm yes. To me it's not so much wrong but colloquial / chatty in style. Happy to change it though.
How about That said, we usually have to write.. (it might not be the only exception), and perhaps changing a bunch of to just the?
There was a problem hiding this comment.
The sentence starting with "Except that" had no main subject and verb, which is why I said it was not correct grammar (you must have both of those to have a valid sentence). But you're right. If we're going for "chatty" then grammar is of no concern. ;)
|
Thanks! |
Fixes #606