Giter Club home page Giter Club logo

Comments (1)

ZedThree avatar ZedThree commented on June 21, 2024

I think there's two separate issues here:

  1. the interface's description doesn't appear in the list of procedures, this seems to only be true for module procedures
  2. if display: private is set (either at the project level, or in the submodule), then links between the module procedure's interface and its implementation are created:

image

image

The first issue is a bug -- I also think it would be better to have it appear as "module procedure" rather than "interface". I'll look into it.

The second one is a consequence of entities in submodules being private by default, and this applies to implementations of module procedures as well. I think this is sensible as submodules are designed to hide implementation details, so only the documentation for the public interface should be shown by default. If you want to have extra developer-only documentation on the implementation, you could enable that with display: private -- making this easier to document public vs private and user vs developer APIs was also raised in #473

from ford.

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.