Rename "description" to "docBlock" in output. about react-docgen

[fkling]

Mmh. Overall I would agree, but the added value doesn't really justify a breaking change. I'll leave this open for the next major version.

[levithomason]

👍

[mik01aj]

@levithomason maybe you would consider using a tool like react-styleguidist that reads your examples from Markdown files? I personally like this approach more. Otherwise you might end up with huge comments in your source code, like here...

[levithomason]

@mik01aj Thanks for the suggestion. I ended writing a gulp plugin that leverages react-docgen and eslint/doctrine for docblock parsing.

As for examples, we're writing and rendering our examples as regular React components. For the code snippet, we use webpack's raw-loader to read the text and highlight it with react-highlightjs. This is working pretty well for us so far.

EDIT
This is great because the example code snippets are written in their native format (rather than a doc string, or markdown). What is rendered is exactly what the consumer will use, including import statements since each example is it's own module.

You can see this result on the doc site for TechnologyAdvice/stardust.

[fkling]

Looking back at this, I don't think that a minor improvement in code aesthetics justifies a breaking change. You can always renamed the property yourself before you process it further.

I'm going to close this for now. If anybody feels really strongly about this, please let me know.