by

Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
  • Mar 21 2016 03:13
    jfirebaugh closed #18
  • Mar 21 2016 03:13
    jfirebaugh commented #18
  • Mar 20 2016 23:11
    jfirebaugh opened #389
  • Mar 20 2016 22:44
    jfirebaugh commented #373
  • Mar 20 2016 22:32
    jfirebaugh synchronize #388
  • Mar 20 2016 22:32
    jfirebaugh synchronize #388
  • Mar 20 2016 22:32

    jfirebaugh on mdast

    @linkcode and @linkplain are in… (compare)

  • Mar 20 2016 22:31
    jfirebaugh synchronize #388
  • Mar 20 2016 22:31

    jfirebaugh on mdast

    Replace markdown strings with p… (compare)

  • Mar 20 2016 22:31
    jfirebaugh synchronize #388
  • Mar 20 2016 22:28

    jfirebaugh on mdast

    Replace markdown strings with p… (compare)

  • Mar 20 2016 22:28
    jfirebaugh synchronize #388
  • Mar 20 2016 22:28
    jfirebaugh synchronize #388
  • Mar 20 2016 22:26
    jfirebaugh opened #388
  • Mar 20 2016 22:26
    jfirebaugh opened #388
  • Mar 20 2016 22:25

    jfirebaugh on mdast

    Replace markdown strings with p… (compare)

  • Mar 20 2016 19:50
    SimenB opened #387
  • Mar 20 2016 18:07
    tmcw commented #365
  • Mar 20 2016 15:56
    paradox41 closed #367
  • Mar 20 2016 15:56
    paradox41 commented #367
Ans
@anselmbradford
Can anyone here help me with documentationjs/documentation#412 ?
Shoot, just realized everyone is offline :P
Fernando Montoya
@montogeek
How the toc defined in documentation.yml works?
I can't make it workin
L
@lorenzopaoliani_twitter
Hey guys, I'm new here! I've been looking around for a way to force documentation to display all a class methods and properties, even those without comments. Is there a way?
Jason Miller
@developit
not currently, no. documentationjs/documentation#433
L
@lorenzopaoliani_twitter
@developit thanks for getting back to me! By the looks of #435 it looks like it should pick up definitions for an exported class, or am I missing something?
Jason Miller
@developit
I scanned around other issues and @tmcw seemed to indicate that anything without a jsdoc-style comment will be ignored.
L
@lorenzopaoliani_twitter
Ok, it would be interesting to add a flag that enables this, and I'm happy to work on it myself :)
Vitor Balocco
@vitorbal

hey everyone! Is there any way to disable linking of primitive types when generating MD format?
E.g. I want this:

-   `hash` **Object** some object.

Instead of this:

-   `hash` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** some object.
Fernando Montoya
@montogeek
It is possible to use multiple entries for the build command?
Jason Laster
@jasonLaster
@montogeek works for me
Erik Arvidsson
@arv
$ node bin/documentation.js build test-a.js test-b.js -f md
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

# a

# b
Fernando Montoya
@montogeek
@jasonLaster I have 2 entry points but want to create a single HTML file
Is that possible?
Jason Laster
@jasonLaster
yep
just list it out
^ @montogeek
Fernando Montoya
@montogeek
Thanks!! Will take a look
Charles F. Munat
@chasm
I'm having real trouble documenting ES6 React/Redux code using pure functions. My sidebar ends up with a dozen mapStateToProps functions, for example. All efforts to use @module have been mixed at best. Is there a link to an example? Has anyone made this work? @typedef is also quite awkward. Am I missing something? TIA.
Erik Arvidsson
@arv
@chasm --document-exported might be more suitable since it only documents bindings that have been explicitly exported.
Peter Street
@LazerFX
I've raised issue #559. I'd like to assist in sorting it out, but I've no experience debugging npm modules. If you can point me in the right direction, I'm sure I can assist :)
Benjamin Lupton
@balupton
Hey everyone, where is the best place to get started on documentationjs/documentation#577
Fernando Montoya
@montogeek
How to use Flow types? I mean, it is there a flag or documentation will automatically do it by checking // @flow comment?
Fernando Montoya
@montogeek

Hi @tmcw
If I want to create docs from the following code:

type CaptureEmail = {
  email: string,
  url: string,
}
const Engage = {
  /**
   * Captures users email upon leaving booking page
   */
  captureEmail: (data: CaptureEmail): Promise<CaptureEmail> => {
  }
}

Do I need latest master changes?

Gajus Kuizinas
@gajus
Hello
Whats the best practise to document helpers functions?
Consider this documentation http://8e3aa602.ngrok.io/
This is a function thats used internally, ./src/utilities/isCookieSet.
Having it here without any context makes little sense.
Is there a way to at least group them under some namespace "utilities"?
Happy-Ferret
@Happy-Ferret
Does documentation support .js.flow files?
Happy-Ferret
@Happy-Ferret
More specifically, does it even support flow declarations? Can't seem to get these to work.
Tom MacWright
@tmcw
Whew, long time no in this channel. But no longer
Tom MacWright
@tmcw
update of yesterday's progress: http://www.macwright.org/2017/04/11/day-2.html
Tom MacWright
@tmcw
okay, first order of business, prettier 1.0.0
Tom MacWright
@tmcw
destructuring parameters are tricky!
David Halls
@davedoesdev
In documentation.yml, how do I specify doc items? I'm getting an error: "Table of contents defined sorting of centro.separate_auth but no documentation with that namepath was found"
I've tried "separate_auth" too which is what documentation generates in the output
David Halls
@davedoesdev
if (!comment.memberof && indexes[comment.name] !== undefined) {
Seems only items which aren't members of a namespace are considered
David Halls
@davedoesdev
hi
jest doesn't seem to be running the fixture *.input.js tests
Oscar Dub
@odub

hey just to say thanks for the project!

i'm happy with how my heavily hacked documentation.js site came out:
mpe.js.org

Prateek Saxena
@prtksxna
@odub That looks really neat
Oscar Dub
@odub
:tada: thanks!
Prateek Saxena
@prtksxna
:+1: