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

Add more Haddocks to the co-log-core package #78

Closed
8 tasks done
chshersh opened this issue Nov 15, 2018 · 0 comments · Fixed by #118
Closed
8 tasks done

Add more Haddocks to the co-log-core package #78

chshersh opened this issue Nov 15, 2018 · 0 comments · Fixed by #118
Assignees
@chshersh
Labels
doc package:co-log-core For: co-log-core
Milestone
0.3.0.0: More fle...

Comments

@chshersh
Copy link
Contributor

chshersh commented Nov 15, 2018 •
edited

The space is empty. But I guess something can be added there. Like, short description of every module (like in Relude) and maybe some usage example.

I will describe documentation improvements under this issue:

  • Top-level Haddock for Colog.Core module
  • Paragraphs in Colog.Core.Action about each instance and data type
  • Use <$ or &> operators in the doctest examples for consistency
  • Add note about co-log IO actions in the Colog.Core.IO
  • Add laws for Colog.Core.Class
  • Add README.md to extra-docs
  • Add Haskell logo to badges
  • Mention tutorial series in the main README.md
@chshersh chshersh added the doc label Nov 15, 2018
@chshersh chshersh added this to To do in #3: Hero Academia (November, 2018) via automation Nov 15, 2018
@chshersh chshersh added the package:co-log-core For: co-log-core label Nov 15, 2018
@chshersh chshersh changed the title Add top-level Haddock to co-log-core package Add more Haddocks to the co-log-core package May 3, 2019
@chshersh chshersh self-assigned this May 5, 2019
chshersh added a commit that referenced this issue May 5, 2019
@chshersh
[#78] Better docs, prepare for the release
d2131f6 
Resolves #78
@chshersh chshersh mentioned this issue May 5, 2019
Merged
vrom911 pushed a commit that referenced this issue May 5, 2019
@chshersh @vrom911
[#78] Better docs, prepare for the release (#118)
f3daeff 
* [#78] Better docs, prepare for the release

Resolves #78

* Update co-log-core/src/Colog/Core/Action.hs 

Co-Authored-By: chshersh <kovanikov@gmail.com>

* Minor fixes to docs

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

@chshersh chshersh

Labels
doc package:co-log-core For: co-log-core
Projects
None yet
Milestone
0.3.0.0: More flexible and convenient...
Development

Successfully merging a pull request may close this issue.

[#78] Better docs, prepare for the release co-log/co-log
1 participant
@chshersh