GithubHelp home page GithubHelp logo

Comments (1)

freider avatar freider commented on June 11, 2024

Oh that's unfortunate! The renderers/parsers I've previously looked at has happily accepted additional data after the language spec.

notest are not the only "info" markers - we also use them for fixture injection and continuation blocks (fixture:blah)

If it doesn't complicate the parsing code we could certainly allow for a separate "comment" syntax, maybe something like:
<!-- pmd-metadata: notest --> (good to have some sort of indicator that it is metadata.

According to this thread https://stackoverflow.com/questions/4823468/comments-in-markdown there doesn't seem to be an obvious "right" way to do comments in markdown, as some html renderers will actually render these comments as well. Some suggest abusing markdown link syntax instead. Anyway, happy to look at a PR if you can think of a clean way of implementing this :)

(I guess another option for you would be to patch mkdocs-material's parser to not break when looking at code blocks with multiple info fragments)

from pytest-markdown-docs.

Related Issues (3)

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.