Coder Social home page Coder Social logo

Comments (2)

kitsonk avatar kitsonk commented on May 3, 2024 1

I'm not personally too sure, as it makes the whole model very complicated, as it is designed to be a per module doc generator. Just globbing would start to force arbitrary semantics, like what is a "private" and what is a "public" module.

Since you can't glob imports, then the one to one relationship of importable item to top level doc page makes sense, as anything else would need additional context, like to do X import Y. The end user creating a README that provides that context and links to individual module pages would make a lot more sense to me.

from docland.

mfulton26 avatar mfulton26 commented on May 3, 2024

Okay, that makes sense. I figured out wouldn't hurt to ask and explore. I love them idea of a README as a directory. It seems a little bit of manual maintenance but I suppose that could be automated without too much trouble. Thanks.

from docland.

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.