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

hasBlock deprecation, documenting (has-block and (has-block-params #469

Closed
mixonic opened this issue Mar 18, 2019 · 9 comments
Closed

hasBlock deprecation, documenting (has-block and (has-block-params #469

mixonic opened this issue Mar 18, 2019 · 9 comments

Comments

@mixonic
Copy link
Sponsor Member

mixonic commented Mar 18, 2019

In working on Octane documentation I realized the following:

  • hasBlock behaves as a keyword in templates, still exists
  • (has-block is a helper which was added intending to replace hasBlock. It is suggested in the guides as best practice but has no API documentation as an Ember helper.
  • (has-block-params is often mentioned by VM developers when (has-block is being discussed, however this is also not documented as a public API.
  • AFAICT there has been no RFC that got us here

I'd like to propose an RFC which would resolve this loose end:

  • RFC would document/describe the (has-block API, including use for inverse blocks.
  • RFC would document/describe the (has-block-params API, including use for inverse blocks.
  • RFC would require that we document the same as API.
  • RFC would propose and document a deprecation for hasBlock

This is related to #460 (@wycats on named blocks) as I believe these APIs will have a lot more use and prominence once named blocks land.

@knownasilya
Copy link
Contributor

Looks like the documentation has been updated here emberjs/ember.js#17767

@MariannaAtPlay
Copy link

Hello,
has hasBlock been deprecated?
Trying to understand the difference btw hasBlock and has-block.

@knownasilya
Copy link
Contributor

It hasn't, but should be. From a user's perspective it seems like there is no difference.

@wycats
Copy link
Member

wycats commented Aug 25, 2020

@knownasilya that is correct. @rwjblue should we open a deprecation RFC? Or is there already one?

@chancancode
Copy link
Member

I think we may not want to touch this while we are working towards template imports? While I do think this will stay a keyword and doesn't make sense to import it, having everything else in camelCase while keeping this in d-a-s-h may be strange.

@wycats
Copy link
Member

wycats commented Aug 27, 2020

@chancancode I agree with this. It's possible that we'll want to use dash-case for keywords, but I agree that we can reserve that conversation for later.

@wycats
Copy link
Member

wycats commented Aug 27, 2020

As a side note: we could consider the new vscode deprecation feature to mark features that we want to discourage. It has pretty nice UI.

@bertdeblock
Copy link
Member

There is now an RFC for deprecating hasBlock and hasBlockParams.

@mixonic
Copy link
Sponsor Member Author

mixonic commented Jan 29, 2021

Closing as I consider this resolved in #689!

@mixonic mixonic closed this as completed Jan 29, 2021
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

No branches or pull requests

6 participants