GithubHelp home page GithubHelp logo

Comments (4)

ttrenka avatar ttrenka commented on May 18, 2024

I think your assumption is wrong; from what I'm reading in the 1.6 details.xml file, all of those are assumed to be summaries (i.e. <summary> elements), which are not Markdown enabled.

Pretty sure you can't include examples in there as well (at least with the old parser).

from js-doc-parse.

wkeese avatar wkeese commented on May 18, 2024

Ugh, @ttrenka you are right... so does that mean that this is also invalid?

// textDir: String
//      Bi-directional support, the main variable which is responsible for the direction of the text.
//      The text direction can be different than the GUI direction by using this parameter in creation
//      of a widget.
//      Allowed values:
//          1. "ltr"
//          2. "rtl"
//          3. "auto" - contextual the direction of a text defined by first strong letter.
//      By default is as the page direction.

(because the numbered list will be smushed into plain text)

from js-doc-parse.

csnover avatar csnover commented on May 18, 2024

I’m happy to just throw most everything through the markdown parser at this point if you want. Seems like nobody paid attention to the fact that they can’t use markdown everywhere…

from js-doc-parse.

wkeese avatar wkeese commented on May 18, 2024

I'm in favor of parsing everything as markdown assuming @ttrenka, @cjolif etc. don't have any strong objections... it seems like markdown is mostly backwards-compatible with plain text. Probably there are some theoretical cases where parsing attributes and summary as markdown could break something, but I don't think it would be a big issue in practice.

from js-doc-parse.

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.