Skip to content

Fix multiple problems with uses and extends #574

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

Closed
wants to merge 7 commits into from

Conversation

spruce
Copy link

@spruce spruce commented Oct 31, 2018

As described in the Issue #532 the links created for the Class DS.RecordArray are wrong.
Instead linking to

/api/ember/3.5/classes/Ember.ArrayProxy and /api/ember-data/3.5/classes/Ember.Evented
when they should link to
/api/ember/3.5/classes/ArrayProxy and /api/ember/3.5/classes/Evented

This is achieved by creating a new helper that removes the Ember. prefix and an update to the projectNameFromClassName() function.

Remaining problems (not caused by this PR):

  • class model only has single value for usedClassProjectName where the basis for the creation of that prop is a array with possibly multiple entries
  • Some Classes extend from the "wrong" Classes, e.g. DS.Adapter uses Ember.Object where it should be EmberObject. I will try and find many errors like this in another PR in ember-data source.

@spruce spruce mentioned this pull request Nov 1, 2018
@spruce spruce force-pushed the fix-extends-uses-links branch from bededba to f13584c Compare November 2, 2018 09:27
@spruce
Copy link
Author

spruce commented Nov 2, 2018

As the commits from the PR #573 are now part of this PR this superseeds #573 and can therefor be closed.

@toddjordan
Copy link
Contributor

Thanks for looking at this. I think we should rather fix the reference in the original documentation (emberjs source). This is really just adding a workaround to the UI. We can do this by just change @uses @extends to their current classnames. (without the Ember.)

@spruce
Copy link
Author

spruce commented Dec 11, 2018

Ok. So just that we are on the same page. Ember should not be prefixed and Ember-data will have DS. prefixed. I will then go in and fix that in the places where I find it.
Doesn't that mean that even in the ember-data namespace. ember is still the default namespace? (I mean if you @uses ArrayProxy means Ember.ArrayProxy and not DS.ArrayProxy.)

@toddjordan
Copy link
Contributor

@spruce Yeah, with the onset of JS module import, Many of the classes traditionally referenced using the Ember global namespace are now referenced with imports. In these cases the ember namespaces was removed from inline documentation. For things like ArrayProxy, you can just refer to ArrayProxy and it will typically resolve it, though not sure about references from ember data (bc it is a separately built documentation)

@locks locks requested a deployment to ead-review-app-pr-574 February 7, 2019 06:21 Abandoned
@toddjordan
Copy link
Contributor

Closing in favor of fixing references in the source documentation

@toddjordan toddjordan closed this Mar 28, 2019
Gaurav0 pushed a commit to Gaurav0/ember-api-docs that referenced this pull request Sep 16, 2019
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.

4 participants