search

gjtorikian / biscotto

UNMAINTAINED. CoffeeScript API documentation tool that uses TomDoc notation.
https://gjtorikian.github.io/biscotto/
MIT License
105 stars 18 forks source link

Use TomDoc style nested hashes #21

Closed kevinsawicki closed 10 years ago

kevinsawicki commented 10 years ago

Switch from key: description to :key - description

Closes #20

gjtorikian commented 10 years ago

This feels more like Ruby than CoffeeScript though (: before the arg name).

You'll also have to fix up this test: https://github.com/atom/biscotto/blob/master/spec/templates/methods/hash_parameters.coffee

I'll figure out why Travis isn't firing for this repo. There it goes. :point_down:

kevinsawicki commented 10 years ago

@gjtorikian Should the build have failed?

kevinsawicki commented 10 years ago

I guess I was leaning towards making it "feel" like TomDoc, wasn't really thinking about the CoffeeScript vs. Ruby differences.

Do you feel strongly about making it feel more Coffee-like?

kevinsawicki commented 10 years ago

@probablycorey do you have any feelings toward either of these styles?

key: Description

:key - Description

probablycorey commented 10 years ago

I like key: Description because it is simpler. But :key - Description matches TomDoc so I would go with that.

kevinsawicki commented 10 years ago

Going to merge this in and fix the specs in a different PR.