Improve documentation #89
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
|
@seancookr @javierg @netlogics @norcal82 This PR's intend is to kick off the documentation improvements, feel free to add commits to this PR. |
| @@ -71,8 +71,9 @@ User.all #Dolly::Collection #<#User...>, <#User...> | |||
| user = User.find "a1b2d3e" #<#User...> | |||
| user.name | |||
|
|
|||
| #Return a User object based on the custom view. | |||
| user = User.view 'view_name', {key: ["a", "b", "c"], reduce: true} | |||
| #Return a User object based on the custom view. `include_docs` is always true for this method. | |||
There was a problem hiding this comment.
Is a User object returned or a json string?
There was a problem hiding this comment.
JSON String, that's why I added the from_json call, as it previously seemed to indicate you'd be getting a User instead of a String.
|
@rubenrails Since no real progress has been made for this, I think we should merge this so as to not let it get stale |
|
|
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.
DON NOT MERGE...YET
Related #86
This PR aims for improving documentation for the current implementation. DO NOT add/change any functionallity, only documentation changes will be merged.