Coder Social home page Coder Social logo

support nested lists about js-doc-parse HOT 6 CLOSED

csnover avatar csnover commented on May 30, 2024
support nested lists

from js-doc-parse.

Comments (6)

wkeese avatar wkeese commented on May 30, 2024

From testing at http://daringfireball.net/projects/markdown/dingus, lists and nested lists work, but the (outer) list cannot be indented. I fixed numerous violations in the dojo source related to indentation so I think that if the doc parser just strips the first two tabs, or whatever the indent is on the first line, then things will work.

from js-doc-parse.

wkeese avatar wkeese commented on May 30, 2024

Also note that with Neil's parser nested lists were hacked like this (taken from dojo/selector/acme.js):

    //          * attribute queries:
    //          |   * `[foo]` attribute presence selector
    //          |   * `[foo='bar']` attribute value exact match
    //          |   * `[foo~='bar']` attribute value list item match
    //          |   * `[foo^='bar']` attribute start match
    //          |   * `[foo$='bar']` attribute end match
    //          |   * `[foo*='bar']` attribute substring match

That doesn't work anymore either.

from js-doc-parse.

wkeese avatar wkeese commented on May 30, 2024

I'll work on a patch for this.

The first problem is here:

function processStandardKey(/**Object*/ metadata, /**string*/ key, /**string*/ line) {
    key = standardKeys[key];

    line = trim(line);

It's indiscriminately trimming all leading whitespace, where it should only be trimming the indent of the value (by our standards, two tabs). That value isn't being recorded at all, so this is more of a case of an unimplemented feature than a bug.

The second issue is that you are expanding tabs to 2 spaces, rather than 4. Not only do dojo developers use 4 spaces for tabs, but markdown requires 4 spaces for indenting lists (and we are using tabs to indent nested lists). Actually, it's more complicated than that, because for something like "//\t" it should expand to 2 spaces.

from js-doc-parse.

wkeese avatar wkeese commented on May 30, 2024

https://github.com/wkeese/js-doc-parse/tree/dojodoc

I'll do some more checking tomorrow though, to make sure everything is OK, and maybe work on the return codes problem too.

from js-doc-parse.

wkeese avatar wkeese commented on May 30, 2024

OK, that's the patch, seems to be working, @AdrianVasiliu you see any issues?

from js-doc-parse.

csnover avatar csnover commented on May 30, 2024

Same as #59

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.