lipp / lipp/doclets

Display function.name instead of module.exports

Open
#165 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
206
Forks
12
PR merge metrics
No merged PRs in 30d

Description

I got a couple of helper functions, which are exported as default. Since I have quite a few of them, they only show up as `module/exports()` in the list.

Let's take this example. This is how my code looks like:

``` js
**
* Creates an HTML template string and returns it.
* @see Code taken from https://hacks.mozilla.org/2015/05/es6-in-depth-template-strings-2/
* @param {String} template - The HTML string written in template strings
* @return {String} result - The new string
*/
export default function HTML (template) {
// ...
}

```

The output in Doclets is like this, among many other `module/exports`:
![screen shot 2016-07-07 at 14 06 38](https://cloud.githubusercontent.com/assets/2461956/16652651/34e713d0-444c-11e6-826b-8ed8a88c705a.png)

This makes it very unorganised and hard to find a function.
Is it possible to display the `function.name` instead? In my previous example it could be like `module/HTML` or similar.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named. Start by reproducing the documented default-export example and locate the doclets rendering path that labels these functions as `module/exports()`. Done means default-exported helpers are listed using their function names, such as `module/HTML`, while other doclet names remain usable.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.