Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document the current code #2

Open
dpp opened this issue Nov 18, 2011 · 2 comments
Open

Document the current code #2

dpp opened this issue Nov 18, 2011 · 2 comments
Assignees
@dpp
Labels
Docs
Milestone
Birthday Present

Comments

@dpp
Copy link
Member

dpp commented Nov 18, 2011

The existing code, especially the Haskell code, needs documentation. Should we use Literate Haskell or just add Haddock style documentation?
@ghost ghost assigned dpp Nov 18, 2011
@jonsterling
Copy link
Contributor

I love the idea of using Literate Haskell... Would be nice to process the source code into a beautiful web site (along the lines of Docco/Marginalia).

@dpp
Copy link
Member Author

dpp commented Apr 14, 2012

Sounds great. I avoided Literate Haskell because of some issues with GHC-iPhone and non-.hs files. GHC-iPhone should be integrated into Haskell 7.6 and I've been coding the latest stuff in 7.4.1, so converting to Literate Haskell is possible and would be a good thing (tm)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dpp dpp

Labels
Docs
Projects
None yet
Milestone
Birthday Present
Development

No branches or pull requests
2 participants
@dpp @jonsterling