ldoc
ldoc copied to clipboard
lunarmodules
Bugs in the documentation
Hi there! It seems, there is a few bugs in the doc.md:
- it links to
@list.moon, while there is onlyList.moon. That leads to
doc/doc.md:725: module not found: list list.moon
- doc/config.ld contains
format=discount, which leads to
format: discount not found, using markdown
Thanks, I just noticed this issue. Comes from doing too much testing on case-insensitive file systems ;)
As for second issue, it's deliberate. LDoc falls back to the default markdown processor if it can't find discount, which I like because it's really fast. Easy to install with luarocks, although not everyone uses LR. The main thing is that the result should be pretty close, either way.
@stevedonovan By the way, the latest markdown on the LuaRocks is now Lua 5.2/5.3 compatible, so you can drop bundled ldoc.markdown if you want.
A good point - I should certainly synchronize with latest Markdown (I suspect that a number of us made markdown.lua work with modern Lua separately). But (again) not everyone uses LuaRocks so I didn't want to add too many external dependencies.
Not everyone uses luarocks, but many using system-wide package manager, which, most of time, able to install lua packages system-wide ;)
(I mean, generally speaking, I dislike bundling 3party libs in the projects, but while it is only small markdown.lua (which was local-patched even by me in my projects), it, maybe, fine).
Yes - Debian has both markdown.lua and lua-discount, although of course the LDoc package is going to be a little bit behind. I understand the principle of not keeping own copies, but it is a small file which makes life easier for people. I'm prepared to keep it in sync with the latest.
