Skip to content
This repository has been archived by the owner on Feb 24, 2021. It is now read-only.

Add space between function description and function signature in docs #5

Open
1Jajen1 opened this issue Oct 25, 2019 · 4 comments
Open
Assignees

Comments

@1Jajen1
Copy link
Member

1Jajen1 commented Oct 25, 2019

2019-10-25_16-25

https://next.arrow-kt.io/docs/apidocs/arrow-core-data/arrow.core/-either/index.html

This just does not look right and it's a pain to read.

@1Jajen1
Copy link
Member Author

1Jajen1 commented Dec 20, 2019

Btw this still happens on the new docs.

@calvellido calvellido self-assigned this Dec 23, 2019
@calvellido
Copy link
Member

calvellido commented Dec 23, 2019

Thanks a lot for pointing this out @1Jajen1.

The source of this is the automated docs generation through Dokka, where we haven't been able yet to found a suitable way to modify this accordingly. We have been trying different approaches, but none really fix this in a clean way.

In Arrow Meta we are trying to overcome this through some CSS, but in a way that introduces some unnecessary line breaks:

https://meta.arrow-kt.io/docs/apidocs/compiler-plugin/arrow.meta.dsl.codegen.asm/-asm-syntax/

I'll try to share any advances we can make in this regard, cheers!

@rachelcarmena rachelcarmena transferred this issue from arrow-kt/arrow Feb 20, 2020
@i-walker
Copy link
Member

There is a fix here. Once it is included in the next Dokka release iteration, we may update the Dokka version. Kotlin/dokka#613

@calvellido
Copy link
Member

calvellido commented Feb 25, 2020

Amazing @i-walker! 🙌

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants