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.

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

Show constructor to use receiver type to enable object property access #835

Merged
merged 2 commits into from
May 6, 2018

Conversation

ersin-ertan
Copy link
Contributor

Solves: #830

@codecov
Copy link

codecov bot commented May 5, 2018

Codecov Report

Merging #835 into master will not change coverage.
The diff coverage is 0%.

Impacted file tree graph

@@            Coverage Diff            @@
##             master     #835   +/-   ##
=========================================
  Coverage     44.41%   44.41%           
  Complexity      633      633           
=========================================
  Files           294      294           
  Lines          7459     7459           
  Branches        834      834           
=========================================
  Hits           3313     3313           
  Misses         3844     3844           
  Partials        302      302
Impacted Files Coverage Δ Complexity Δ
...eclasses/src/main/kotlin/arrow/typeclasses/Show.kt 0% <0%> (ø) 0 <0> (ø) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 48fd05d...e36a1de. Read the comment docs.

@pakoito
Copy link
Member

pakoito commented May 5, 2018

Could you please use this chance to add a reference to the invoke constructor in the docs? I'm surprised we don't use it in the codebase either, so good news hahaha

https://github.com/arrow-kt/arrow/edit/master/modules/docs/arrow-docs/docs/docs/typeclasses/show/README.md

@ersin-ertan
Copy link
Contributor Author

Good tip - I'll create a snippet

@pakoito
Copy link
Member

pakoito commented May 6, 2018

This is a great chance to learn about Ank!! Ank is the tool we use to compile snippets. What is does is output the result of the last expression inside a block. With the changes you've introduced, as they're in the same block, they won't produce the snippet result. Compare the docs with the source: https://arrow-kt.io/docs/typeclasses/show/ The snippet will also fit better on the create your own instance section: https://arrow-kt.io/docs/typeclasses/show/#creating-your-own-show-instances

If you'd like to test Ank, use ./gradlew runAnk, and find the files in the arrow-docs output folder.

@ersin-ertan ersin-ertan force-pushed the master branch 2 times, most recently from 087f218 to d5f59cc Compare May 6, 2018 20:01
@ersin-ertan
Copy link
Contributor Author

ersin-ertan commented May 6, 2018

Show and Eq examples moved to Create your own instance locations(in separate anks).
Previous commits squashed into a single commit.
Updated branch with other arrow commits.
👍

Copy link
Member

@pakoito pakoito left a comment

Choose a reason for hiding this comment

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

Let's mergeeeeeeee 🎉

@pakoito pakoito merged commit 71d0e44 into arrow-kt:master May 6, 2018
@pakoito
Copy link
Member

pakoito commented May 6, 2018

Thanks @ersin-ertan for the contribution!

RawToast pushed a commit to RawToast/kategory that referenced this pull request Jul 18, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants