Comments (3)
I think the latest push should sort out the issue. It came as a surprise to me, but @{mod}
wasn't implemented properly! It was finding the module object and then didn't know how to turn it into a reference.
from ldoc.
Actually, the latest push indeed fixed some odds. And that's perfect. Huge thanks for that.
Although the initial problem remains unsolved, but I do have the feeling I haven't stated my point incorrectly.
Here is an example.
In lib.lua, the description for lib.newLog
function has a inlined reference (with backticks) to the module core.log, but the generated documentation won't convert that reference into an HTML link, but just wrap it into <code></code>
tags.
Well replacing log
with core.log
produces the desired output, and that's normal, as the very name of the inner submodule is core.log
. But keeping it as it is makes it easier to read, instead of writing:
--- Returns a `core.log` instance.
-- @treturn log a `core.log` instance
function lib.newLog() ... end
from ldoc.
It is a little hard to tell since the MWE repository has been removed, but it seems to me that needing the fully qualified module name is expected. If the only remaining thing here is a request for a shortcut way of reaching submodules, I think I'm going to suggest that's not a great idea for long term maintainability. I would be too easy to get things cross-wired if the module was ever refactored and not notice the problem.
If there is something else I'm missing feel free to comment for re-evaluation. Alternatively if anybody has a PR they think is an improvement that doesn't break anything else I'd definitely consider the use case.
from ldoc.
Related Issues (20)
- luarocks install ldoc throw 404 HOT 1
- Representing module with constants HOT 2
- LDoc fails to reference to a table value HOT 1
- Using custom CSS (-s option) fails with error: ldoc/tools.lua:233: attempt to compare number with nil HOT 2
- Part after dot is ignored HOT 2
- How to add description of example script HOT 1
- @type changes behavior when used in @submodule HOT 5
- LuaRocks module: broken link to project homepage HOT 2
- How to use @script tag? HOT 2
- Filename case issues for cross-platform document generation HOT 5
- --fatalwarnings returns 0 exit code with invalid Markdown references
- Error message on invalid tag somewhat obtuse and doesn't point out the issue being the undefined tag HOT 10
- LDoc breaks when loading config file. HOT 2
- [Meta] Is this repo dead? HOT 2
- How do I ignore certain files/directories? HOT 2
- `hxx` extension support HOT 2
- multiple raise statements cause error HOT 6
- Support nested subparams HOT 2
- Question: is there a way to generate document from lua-language-server type annotations?
- Add LuaCATS as alternative tag handling scheme HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ldoc.