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

Link to doc in README is dead #383

Open
nwhittaker opened this issue May 16, 2023 · 3 comments
Open

Link to doc in README is dead #383

nwhittaker opened this issue May 16, 2023 · 3 comments

Comments

@nwhittaker
Copy link

For more documentation, consult https://emberjs.com/api/ember/release/classes/String.

Looks like it was removed with the 4.12 release of Ember.

@tniezurawski
Copy link

Any update on this folks? If @ember/string is no longer in the documentation:

image

Maybe documentation should be provided in the repo? Who is responsible for this project? Who can make things moving?

@NullVoxPopuli
Copy link
Sponsor Contributor

NullVoxPopuli commented Oct 13, 2023

As of ember v5, ember-string was removed from the framework.

Here is the relevant deprecation: https://deprecations.emberjs.com/v4.x#toc_ember-string-add-package

It exists separately as on installable dep (with docs) here: https://github.com/emberjs/ember-string

However, you may be interested in something more robust:
https://www.npmjs.com/package/change-case?activeTab=readme

@tniezurawski
Copy link

Thanks @NullVoxPopuli 🙌

It exists separately as on installable dep (with docs) here: https://github.com/emberjs/ember-string

hmm, I believe the issue is that docs don't exist here 🤔 Unless I'm missing something

However, you may be interested in something more robust: https://www.npmjs.com/package/change-case?activeTab=readme

That's a good suggestion 👍 But I think @ember/string is currently too deeply grown into the ember ecosystem to be replaced easily. I tried to replace it with change-case in my project and realized that ember-autoresize-modifier uses it, but doesn't state it in the dependencies which I guess is a problem for pnpm (maybe other package managers as well?) and my build fails.

I still think that replacing the link we have in README:

Usage

This package provides the following imports:

import {
  camelize,
  capitalize,
  classify,
  dasherize,
  decamelize,
  underscore,
  w,
} from '@ember/string'

For more documentation, consult https://emberjs.com/api/ember/release/classes/String.


☝️ with actual documentation that can be found in 4.9 -> https://api.emberjs.com/ember/4.9/classes/String/methods, would be beneficial here.

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

3 participants