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

Update the guides for element modifiers #1946

Merged
merged 2 commits into from
Aug 11, 2023
Merged

Conversation

mixonic
Copy link
Contributor

@mixonic mixonic commented Jul 19, 2023

At emberjs/rfcs#934 we're tracking an effort to implement the RFC emberjs/rfcs#811. In that RFC (at
https://github.com/emberjs/rfcs/blob/master/text/0811-element-modifiers.md#how-we-teach-this) there are two things which are suggested for documentation in the guides:

@netlify
Copy link

netlify bot commented Jul 19, 2023

Deploy Preview for ember-guides ready!

Name Link
🔨 Latest commit 1031576
🔍 Latest deploy log https://app.netlify.com/sites/ember-guides/deploys/64d67d890a99360008a33511
😎 Deploy Preview https://deploy-preview-1946--ember-guides.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

At emberjs/rfcs#934 we're tracking an effort to
implement the RFC emberjs/rfcs#811. In that RFC
(at
https://github.com/emberjs/rfcs/blob/master/text/0811-element-modifiers.md#how-we-teach-this)
there are two things which are suggested for documentation in the
guides:

* Update references that mention `ember-modifier` must be installed,
  since it ships in the default blueprint (confirmed at
  https://github.com/ember-cli/ember-new-output/blob/master/package.json#L50)
* Introduce the class-based modifier API. In this PR I've linked to the
  upstream documentation at
  https://github.com/ember-modifier/ember-modifier#usage to execute on
  that suggestion. I don't believe we need to laborously explain the
  class-based APIs to guides readers, it just distracts from some
  otherwise straight-forward use cases and examples.
Copy link
Contributor

@MinThaMie MinThaMie left a comment

Choose a reason for hiding this comment

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

Looks good :)

@mixonic mixonic merged commit b557a8b into master Aug 11, 2023
3 checks passed
@mixonic mixonic deleted the mixonic/modifier-docs branch August 11, 2023 18:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants