search

skrapeit / skrape.it

A Kotlin-based testing/scraping/parsing library providing the ability to analyze and extract data from HTML (server & client-side rendered). It places particular emphasis on ease of use and a high level of readability by providing an intuitive DSL. It aims to be a testing lib, but can also be used to scrape websites in a convenient fashion.
https://docs.skrape.it
MIT License
789 stars 57 forks source link

[BUG] KDoc should use Kotlin formatting, not Javadoc #195

Closed aSemy closed 1 year ago

aSemy commented 2 years ago

Describe the bug

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

https://github.com/skrapeit/skrape.it/blob/e429fdc1e15763d5dafc887ee4d5c3bd1e1cadd9/html-parser/src/main/kotlin/it/skrape/selects/DocElement.kt#L23

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!",
     */
msotho commented 1 year ago

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

christian-draeger commented 1 year ago

Hello, merge requests are very welcome :)

msotho commented 1 year ago

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

msotho commented 1 year ago

I believe we can now close this issue?

Thanks.

christian-draeger commented 1 year ago

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