Coder Social home page Coder Social logo

Missing documentation in VS Code about ccxt HOT 7 OPEN

Nomad-Soul avatar Nomad-Soul commented on May 24, 2024 2
Missing documentation in VS Code

from ccxt.

Comments (7)

carlosmiei avatar carlosmiei commented on May 24, 2024

Hello @Nomad-Soul, thanks for reporting it, we will take a look, in the meantime you can access our docs here: https://docs.ccxt.com/#/

from ccxt.

ttodua avatar ttodua commented on May 24, 2024

@Nomad-Soul just for completeness, could you share reproducible tsconfig.json (if you use ) ?

from ccxt.

ttodua avatar ttodua commented on May 24, 2024

I get this:
img
as visible, it shows symbols and params

from ccxt.

ttodua avatar ttodua commented on May 24, 2024

@carlosmiei maybe you can re-assign this to SamGermain, because it would be jsdoc related

from ccxt.

ttodua avatar ttodua commented on May 24, 2024

We might need https://github.com/TypeStrong/typedoc

from ccxt.

Nomad-Soul avatar Nomad-Soul commented on May 24, 2024

I get this: img as visible, it shows symbols and params

That's what I see too, but I meant that there is no documentation for what the parameters do or need.
The same information that is available on docs.ccxt.com:
image

Some methods seem to have jsdoc tags in the source code, but these are not visible through intellisense. Should those tags appear before the function signature? But indeed many of the main methods don't have any documentation.

image

from ccxt.

Nomad-Soul avatar Nomad-Soul commented on May 24, 2024

This is my jsconfig.json:

{
  "compilerOptions": {
    "module": "NodeNext",
    "target": "ES6",
    "checkJs": true,
    "moduleResolution": "nodenext",
    "lib": ["ES2022", "DOM"],
    "allowJs": true
  },
}

from ccxt.

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.