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

amp-fx-collection: documentation #13268

Merged
merged 4 commits into from
Feb 6, 2018
Merged

Conversation

aghassemi
Copy link
Contributor

No description provided.

@aghassemi aghassemi requested review from a user, cvializ and cathyxz February 5, 2018 19:25
</tr>
<tr>
<td class="col-fourty"><strong><a href="https://www.ampproject.org/docs/guides/responsive/control_layout.html">Supported Layouts</a></strong></td>
<td>None</td>
Copy link
Contributor

Choose a reason for hiding this comment

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

None or nodisplay? I've seen nodisplay a couple of times, e.g. in amp-image-lightbox that I'm currently heavily referencing...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

</tr>
<tr>
<td width="40%"><strong>Examples</strong></td>
<td>See AMP By Example's <a href="https://ampbyexample.com/components/amp-fx-collection/">annotated amp-fx-collection</a> example.</td>
Copy link

Choose a reason for hiding this comment

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

  1. If there's no example, consider removing the row until there is one.

- A value less than 1 scrolls the element downward (element scrolls slower) when the user scrolls downward.
- A value of 1 behaves normally.
- A value of 0 effectively makes the element scroll fixed with the page.

Copy link

Choose a reason for hiding this comment

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

Please add a validation section (that's standard for component docs) (example: https://github.com/ampproject/amphtml/blob/master/extensions/amp-video/amp-video.md#validation).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

- A value less than 1 scrolls the element downward (element scrolls slower) when the user scrolls downward.
- A value of 1 behaves normally.
- A value of 0 effectively makes the element scroll fixed with the page.

Copy link

Choose a reason for hiding this comment

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

As this component uses common-extension-attrs, please include the section for "common attributes", like in this component -> https://github.com/ampproject/amphtml/blob/master/extensions/amp-video/amp-video.md#common-attributes

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it does not use any of the common attributes ( actually it is not a components itself, the extensions allows the use of amp-fx attribute. There is no <amp-fx-collection> tag per say)

Copy link
Contributor

@cvializ cvializ left a comment

Choose a reason for hiding this comment

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

Other reviewers' comments make sense to me, otherwise LG

@aghassemi
Copy link
Contributor Author

@bpaduch all done, PTAL

@aghassemi aghassemi merged commit 2ee9b80 into ampproject:master Feb 6, 2018
protonate pushed a commit to protonate/amphtml that referenced this pull request Feb 26, 2018
RanAbram pushed a commit to RanAbram/amphtml that referenced this pull request Mar 12, 2018
protonate pushed a commit to protonate/amphtml that referenced this pull request Mar 15, 2018
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.

None yet

5 participants