skrapeit/skrape.it

[BUG] KDoc should use Kotlin formatting, not Javadoc

aSemy opened this issue · 5 comments

aSemy commented

Describe the bug

In some KDoc {@code ...} is used

* For example, given HTML {@code <p>Hello <b>there</b> now!</p>}, {@code p.ownText()} returns {@code "Hello now!"},

KDoc uses a flavour of Markdown, so replace this with backticks

     /** 
     * For example, given HTML `<p>Hello <b>there</b> now!</p>`, `p.ownText()` returns `"Hello now!",
     */ 

Hello. I would like to contribute and work on this first bug. Thank you

Hello, merge requests are very welcome :)

Apologies if already documented somewhere, but is there a standard naming of branches for bugs or features?

I believe we can now close this issue?

Thanks.

Ah yes, thx for the reminder 😀 and thx again for your help 🙂