MSON block descriptions and markdown in descriptions could be improved

jamesramsay commented 9 years ago

It seems MSON block descriptions don't render at all at the moment?

https://github.com/apiaryio/mson/blob/master/MSON%20Specification.md#41-block-description

It would be really great to support longer descriptions to help the humans who don't read the JSON schema. Also, markdown bold and italics definitely help highlight certain critical pieces of information.

FORMAT: 1A

# Blueprint

## Item [/item]

+ Attributes
    - id: 1 (number) - This description renders nicely
    - name: example (string) - This one doesn't _render italics_ or **bold**
    - short_description: foobar (string) - First line renders
        This doesn't render at all!
    - description: foobar (string)
        This doesn't render at all!

### Get Item [GET]

+ Response 200 (application/json)

    + Attributes (Item)

zdne commented 9 years ago

That is correct. It should be addressed in the – now infamous – #191

pksunkara commented 9 years ago

I think this can be closed as a duplicate of #191

apiaryio / api-blueprint

MSON block descriptions and markdown in descriptions could be improved #239