Coder Social home page Coder Social logo

Comments (2)

surma avatar surma commented on May 20, 2024

One possible solution is that clicking on the type should go to the declaration of ServeDirOptions in the source. I don't think we should show it on the documentation page because that could give the false impression that it's exported.

I am not sure I agree. TypeScript handles exported functions with non-export parameter types (even auto-completion does), so some libraries will pro-actively use this (and I know some that do). My personal preference would be to inline the definition, regardless of whether it’s exported. If we want to distinguish export vs non-export, we can put the word “export” in front of the definition (or something along those lines).

The problem I worry about is that people are gonna publish code in the style they prefer, and docland should support developers in finding the info they need.

from docland.

kitsonk avatar kitsonk commented on May 20, 2024

I think there is a difference between linking to a symbol and allowing it to be displayed, and displaying the symbol on an index page of a module. For those, I think we should keep it only for the exported symbols.

Linking to symbols is related to #62 where we need to come up with some sort of index for symbols.

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.