scylladb-zpp-2024-javascript-driver / scylladb-javascript-driver

Apache License 2.0
6 stars 0 forks source link

Consider if html tags should stay in js-docs #76

Open adespawn opened 2 weeks ago

adespawn commented 2 weeks ago

This may be useful if generating html documentation based on js-docs, bu there can be alternative, cleaner ways of doing it. With Markdown plugin we can try to keep the structure of the documentation, while making it more readable in code and in VScode preview, as the lest one doesn't parse html tags

adespawn commented 2 weeks ago

This can be done either with some global changes, or by hand in each eddied place, alongside other changes

ZuzaOsa commented 1 week ago

It should also be verified if the documentation generates correctly after the changes. If `` is put inside a paragraph it does not work, but it works when using empty line.