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

Add resource-level meta docs. Update top-level meta docs. #1566

Merged
merged 1 commit into from
Mar 11, 2016

Conversation

remear
Copy link
Member

@remear remear commented Mar 9, 2016

Purpose

Improve meta documentation.

Changes

  • Add resource-level meta docs
  • Clarify top-level meta docs

Related GitHub issues

#1235

@@ -81,8 +81,12 @@ PR please :)

#### meta

If you want a `meta` attribute in your response, specify it in the `render`
call:
A `meta` member can be used to include non-standard meta-information. `meta` can
Copy link
Member

Choose a reason for hiding this comment

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

s/non-standard/custom (or something to that effect)

Copy link
Member Author

Choose a reason for hiding this comment

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

Sure, although that's copy from the JSON API docs.

Copy link
Member

Choose a reason for hiding this comment

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

You're right. I saw that later :embarrassed:

On Wed, Mar 9, 2016 at 8:40 AM Ben Mills notifications@github.com wrote:

In docs/general/rendering.md
#1566 (comment)
:

@@ -81,8 +81,12 @@ PR please :)

meta

-If you want a meta attribute in your response, specify it in the render
-call:
+A meta member can be used to include non-standard meta-information. meta can

Sure, although that's copy from the JSON API docs.


Reply to this email directly or view it on GitHub
https://github.com/rails-api/active_model_serializers/pull/1566/files#r55526872
.

@NullVoxPopuli
Copy link
Contributor

LGTM, i'll merge, unless @bf4 has actionable comments

@bf4
Copy link
Member

bf4 commented Mar 11, 2016

Haven't had time to review. I trust it's an improvement, which is the most important thing. First, do no harm and all.

B mobile phone

On Mar 11, 2016, at 6:36 AM, L. Preston Sego III notifications@github.com wrote:

LGTM, i'll merge, unless @bf4 has actionable comments


Reply to this email directly or view it on GitHub.

@NullVoxPopuli
Copy link
Contributor

looks good then, further changes, could be in an additional PR. :-)

NullVoxPopuli added a commit that referenced this pull request Mar 11, 2016
Add resource-level meta docs. Update top-level meta docs.
@NullVoxPopuli NullVoxPopuli merged commit 0c8abf2 into rails-api:master Mar 11, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants