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

Improve documentation for the 'Relude.Debug' module #304

Closed
4 tasks done
chshersh opened this issue Jun 4, 2020 · 0 comments · Fixed by #359
Closed
4 tasks done

Improve documentation for the 'Relude.Debug' module #304

chshersh opened this issue Jun 4, 2020 · 0 comments · Fixed by #359
Assignees
@chshersh @vrom911
Labels
doc README, Haddock documentation, tutorials
Milestone
v1.0.0.0: Officia...

Comments

@chshersh
Copy link
Contributor

chshersh commented Jun 4, 2020 •
edited

  • Write what each function does in addition to simply linking to base functions
  • Mention similar functions in documentation for each function to suggest different use-cases
  • Write top-level description of the module and how tracing functions work
  • Probably rearrange export list for better clarity?
@chshersh chshersh added the doc README, Haddock documentation, tutorials label Jun 4, 2020
@chshersh chshersh added this to the v0.8.0.0: Standard milestone Jun 4, 2020
@vrom911 vrom911 self-assigned this Mar 11, 2021
@chshersh chshersh self-assigned this Mar 11, 2021
chshersh added a commit that referenced this issue Mar 11, 2021
@chshersh
[#304] Improve documentation for the 'Relude.Debug' module
2a01dd9 
Resolves #304
@chshersh chshersh mentioned this issue Mar 11, 2021
Merged
vrom911 added a commit that referenced this issue Mar 11, 2021
@chshersh @vrom911
[#304] Improve documentation for the 'Relude.Debug' module (#359)
60995b9 
* [#304] Improve documentation for the 'Relude.Debug' module

Resolves #304

* Update src/Relude/Debug.hs

Co-authored-by: Veronika Romashkina <vrom911@gmail.com>

* Fix doctest

Co-authored-by: Veronika Romashkina <vrom911@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@chshersh chshersh

@vrom911 vrom911

Labels
doc README, Haddock documentation, tutorials
Projects
None yet
Milestone
v1.0.0.0: Official standard release
Development

Successfully merging a pull request may close this issue.

[#304] Improve documentation for the 'Relude.Debug' module kowainik/relude
2 participants
@chshersh @vrom911