search

omniscientjs / immstruct

Immutable data structures with history for top-to-bottom properties in component based libraries like React. Based on Immutable.js
374 stars 21 forks source link

Update api.md #80

Closed DylanPiercey closed 9 years ago

DylanPiercey commented 9 years ago

Add js highlighting for github.

mikaelbr commented 9 years ago

Hi. Thanks for submitting a PR and helping out! This file however is generated from the jsdoc-comments in the source code. See the build-docs command. If you want you could improve readability by adding the highlighting to the jsdocs comment them self.

E.g. making https://github.com/omniscientjs/immstruct/blob/master/index.js#L10-L12 into code blocks as https://github.com/omniscientjs/immstruct/blob/master/index.js#L36-L39.

I'm leaving this PR open in case you want to amend your commit.