Skip to content
This repository has been archived by the owner on Nov 5, 2018. It is now read-only.

[readme] Errors/Incomplete documentation #37

Closed
Raynos opened this issue Nov 14, 2011 · 3 comments
Closed

[readme] Errors/Incomplete documentation #37

Raynos opened this issue Nov 14, 2011 · 3 comments
Assignees
Labels

Comments

@Raynos
Copy link

Raynos commented Nov 14, 2011

Nowhere did you mention that the callback format is

(err, body, headers)

You also don't mention whether body is a string or whether you json parsed it internally.

Oh and then your examples are (err, response, headers) ¬_¬

Turns out from the source that the second argument is a JSON parsed body if it's not binary.

@dscape
Copy link
Contributor

dscape commented Nov 14, 2011

Yup all true. Documentation is as minimalistic as nano, but in this it's too much.

Also missing is the fact that non 200 codes are sent as errors in the couch scope.

Mind to fork it and do a pull request? :)

@ghost ghost assigned dscape Nov 14, 2011
@Raynos
Copy link
Author

Raynos commented Nov 14, 2011

Lazy.

I'll fix your docs after I've used nano some more. Refactoring some request code to use nano

@dscape
Copy link
Contributor

dscape commented Nov 14, 2011

@Raynos first thanks. It's awesome to tell us what needs to be better but
would be even better if you could just fix those things. That's what open
source is all about :)

Code is in heavy refactor mode in the browser branch. We are working on
porting nano to the browser right now. Please check that before any
refactoring so we don't loose out on the awesome stuff you are working on!

@dscape dscape closed this as completed in 598dc30 Nov 14, 2011
notslang pushed a commit to notslang/nano that referenced this issue Apr 8, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

2 participants