search

kosen13s / tiny

A tiny programming language to improve kosen13s' skills
MIT License
4 stars 0 forks source link

write comment and unify commenting format #16

Closed Iruyan-Zak closed 7 years ago

Iruyan-Zak commented 7 years ago

And I suggest to unify a format of commenting now.

Iruyan-Zak commented 7 years ago

My format is

-- |
-- (comments with line breaks per sentences without blank line)
-- (blank line)
-- >>> (doctest codes without blank line)
-- (blank line)
(function type definition)
Iruyan-Zak commented 7 years ago

Sorry, I forgot writing a comment on TinyParser.hs/between. I rename this issue and fix here.

Roadagain commented 7 years ago

i wrote comments as your format. please check it if you have time.

Iruyan-Zak commented 7 years ago

Even if not to the all, I ask you to attach some use of functions by the form of DocTest, please.

Roadagain commented 7 years ago

TreeState includes a function in itself, so it is difficult to attach doctest. do others satisfy your need?

Roadagain commented 7 years ago

thx to add doctest. so can i create PR to develop ?