Giter Club home page Giter Club logo

Comments (3)

stevedonovan avatar stevedonovan commented on June 24, 2024

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.

Yonaba avatar Yonaba commented on June 24, 2024

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.

alerque avatar alerque commented on June 24, 2024

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.