ember-learn / ember-learn/ember-api-docs

Documentation website links / search / description

Open
#644 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
75
Forks
111
Avg merge
45m
Merged PRs (30d)
1

Description

This one will probably need to be broken down to multiple issues. So please bear with me:

Landing on the [class Helper](https://api.emberjs.com/ember/3.13/classes/Helper/methods) page this morning I noticed that although the example uses `format-currency` helper name, the code block for that helper says only `currency.js`

![Screenshot 2019-10-25 at 09 59 15](https://user-images.githubusercontent.com/847473/67558107-3d350b00-f70e-11e9-8cee-bbd7855818c4.png)

So I thought I would help by clicking on the "edit" button and issuing PR directly from [Github editor](https://github.com/emberjs/ember.js/edit/release/packages/@ember/-internals/glimmer/lib/helper.ts#L46).

But the code block there reads (at line 64): `app/helpers/format-currency.js`, so now I'm not sure whether:
a) I'm looking at different *branch* of the github repo. In which case the edit button is wrong to taking me to branch *release*.
b) The branch *release* is actually correct for this case, but the component that displays the code snippet has a bug that trims `app/helpers/format-currency.js` to `currency.js`?

Right after that I noticed that down below in the code there is a mention about "helper function":
> In many cases, the ceremony of a full `Helper` class is not required.

Never saw that. So I tried to go back to guides page and search for it, but no results:
![Screenshot 2019-10-25 at 10 05 23](https://user-images.githubusercontent.com/847473/67558495-027fa280-f70f-11e9-8088-2829b25ff93d.png)

[But the page for helper as function](http://api.emberjs.com/ember/3.13/functions/@ember%2Fcomponent%2Fhelper/helper) (when I crafter the URL manually) does exist.

So I went to see the respective item in the side menu on that page. The item is not there:

![Screenshot 2019-10-25 at 10 08 29](https://user-images.githubusercontent.com/847473/67558736-71f59200-f70f-11e9-8d8d-601eaba5a026.png)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.