Skip to content

[#173] Haddock Examples - WIP#186

Merged
chshersh merged 7 commits intokowainik:documentation-examplesfrom
Cmdv:Haddock-Examples
Sep 30, 2019
Merged

[#173] Haddock Examples - WIP#186
chshersh merged 7 commits intokowainik:documentation-examplesfrom
Cmdv:Haddock-Examples

Conversation

@Cmdv
Copy link
Copy Markdown
Contributor

@Cmdv Cmdv commented Sep 11, 2019

Resolves #173

Checklist:

HLint

  • I've changed the exposed interface (add new reexports, remove reexports, rename reexported things, etc.).
    • I've updated hlint.dhall accordingly to my changes (add new rules for the new imports, remove old ones, when they are outdated, etc.).
    • I've generated the new .hlint.yaml file (see this instructions).

General

  • I've updated the CHANGELOG with the short description of my latest changes.
  • All new and existing tests pass.
  • I keep the code style used in the files I've changed (see style-guide for more details).
  • I've used the stylish-haskell file.
  • My change requires the documentation updates.
    • I've updated the documentation accordingly.
  • I've added the [ci skip] text to the docs-only related commit's name.

Working my way through adding code examples for all the functions, some of them will need discussing as I'm not 100% of best solutions. for example would be nice to see all the lift helpers and lens not too sure how to go about them.

@chshersh chshersh added the doc README, Haddock documentation, tutorials label Sep 12, 2019
chshersh
chshersh suggested changes Sep 12, 2019
View reviewed changes
Copy link
Copy Markdown
Contributor

@chshersh chshersh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Cmdv Thank you very much for improving the documentation! Working on docs is hard, so I left some comments with my suggestions and potential improvements. But I believe that the docs will become even better 🙂

chshersh
chshersh reviewed Sep 13, 2019
View reviewed changes
@Cmdv
Copy link
Copy Markdown
Contributor Author

Cmdv commented Sep 16, 2019

Done a bunch more examples but quite a few still need thinking about how to show or not show examples 😄

@Cmdv Cmdv changed the title Haddock Examples - WIP [#173] Haddock Examples - WIP Sep 16, 2019
vrom911
vrom911 reviewed Sep 18, 2019
View reviewed changes
Copy link
Copy Markdown
Member

@vrom911 vrom911 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few minor comments from me :)

chshersh
chshersh reviewed Sep 18, 2019
View reviewed changes
Copy link
Copy Markdown
Contributor

@chshersh chshersh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So far so good! I left some comments and some more suggestions regarding further doc improvements

@Cmdv
Copy link
Copy Markdown
Contributor Author

Cmdv commented Sep 18, 2019

Thanks @vrom911 & @chshersh I'll go through the reviews tomorrow and make amends 👍

@chshersh
Copy link
Copy Markdown
Contributor

chshersh commented Sep 19, 2019

@Cmdv thanks for working on this issue 👍 Btw, we've added support for GHC-8.8 in master recently. So it would be good to rebase this PR on top of master to make sure that tests are passing on the latest GHC version.

@Cmdv
Copy link
Copy Markdown
Contributor Author

Cmdv commented Sep 25, 2019

will get back onto this tomorrow, got a little carried away with Exercism.io 😹

@Cmdv
Copy link
Copy Markdown
Contributor Author

Cmdv commented Sep 26, 2019

Just a couple left which I'm a little stuck as I can't quite work out how to test them in ghci or have enough knowledge of good examples 😄

chshersh
chshersh reviewed Sep 27, 2019
View reviewed changes
Copy link
Copy Markdown
Contributor

@chshersh chshersh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So far so good, there's an improvent 👍 I left some comments and suggestions regarding possible tests.

@Cmdv
Copy link
Copy Markdown
Contributor Author

Cmdv commented Sep 30, 2019

went through all of your comments @chshersh 😄 , thanks a lot for working me through theses. Feels like it might have been quicker for you to do them your self 😂

@chshersh chshersh changed the base branch from master to documentation-examples September 30, 2019 13:48
@chshersh
Copy link
Copy Markdown
Contributor

chshersh commented Sep 30, 2019

@Cmdv Haha, o problems! I hope it was a great learning experience for you 🙂

@chshersh chshersh merged commit 8db924d into kowainik:documentation-examples Sep 30, 2019
@Cmdv
Copy link
Copy Markdown
Contributor Author

Cmdv commented Sep 30, 2019

yeah it was great thanks @chshersh I'll try help out with some other bits kowainik related 👍

vrom911 pushed a commit that referenced this pull request Oct 1, 2019
@chshersh @vrom911
Documentation examples (#197)
cb02810 
* [#173] Haddock Examples - WIP (#186)

* making a start to adding code examples

* make recomended ammends, add descriptions to Relude.File

* do a bunch more examples with questions

* some review ammends

* making more ammends using review comments

* amending compile issues and sugestions

* Fix doctest tests and improve examples

* Minor fixes
@chshersh chshersh added the Hacktoberfest https://hacktoberfest.digitalocean.com/ label Nov 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vrom911 vrom911 vrom911 left review comments

+1 more reviewer

@chshersh chshersh chshersh requested changes

Reviewers whose approvals may not affect merge requirements

Assignees

@Cmdv Cmdv

Labels

doc README, Haddock documentation, tutorials Hacktoberfest https://hacktoberfest.digitalocean.com/

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Cmdv @chshersh @vrom911