Skip to content
This repository has been archived by the owner on Aug 2, 2020. It is now read-only.

Improve haddock coverage of the project #55

Closed
angerman opened this issue Dec 26, 2015 · 2 comments
Closed

Improve haddock coverage of the project #55

angerman opened this issue Dec 26, 2015 · 2 comments
Labels
documentation enhancement help wanted
Milestone
ghc-quake

Comments

@angerman
Copy link
Collaborator

I'm lost from time to time in the source, trying to figure out how the parts belong together. I guess adding more extensive documentation to the functions would help with this in a big way.
@angerman angerman mentioned this issue Dec 26, 2015
Closed
@snowleopard
Copy link
Owner

More documentation would be great. However, bear in mind that the codebase is still unstable and large refactorings, such as #18, are coming.

@snowleopard snowleopard added this to the ghc-quake milestone Jan 12, 2016
snowleopard added a commit that referenced this issue Feb 26, 2016
@snowleopard
Add comments.
d8a249b 
See #55.
snowleopard added a commit that referenced this issue May 5, 2016
@snowleopard
Add comments.
acf2160 
See #55. [skip ci]
@snowleopard snowleopard mentioned this issue May 6, 2016
Closed
4 tasks
@snowleopard
Copy link
Owner

I've been continuously improving Haddock coverage in Hadrian, and now I think we are in a good shape. Let me therefore close this issue, but if there are any specific places that require better documentation, please feel free to reopen, or better raise a new specific issue.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation enhancement help wanted
Projects
None yet
Milestone
ghc-quake
Development

No branches or pull requests
2 participants
@angerman @snowleopard