GithubHelp home page GithubHelp logo

Comments (4)

xoxys avatar xoxys commented on July 23, 2024

Hi, Thanks for your report. That's because the documentation is wrong here. The value will always be parsed as json/yaml, but therefor you need to flag it with a $.

Example:

## Content after the $ need to be a valid json; this json will be translated to YAML for the generated docs.
## Simple value
# @var demo_role_override: $ "test"
demo_role_override: original

## Complex value
# @var demo_role_override_complex:value: $ {"foo":"bar", "second":"value"}
demo_role_override_complex: {}

Rendered docs output:

demo_role_override: test
demo_role_override_complex:
  foo: bar
  second: value

Quoting matters in this case as well. I'll fix the documentation later.

from ansible-doctor.

xoxys avatar xoxys commented on July 23, 2024

Hope that helps. If not please let us know.

from ansible-doctor.

DrySimon avatar DrySimon commented on July 23, 2024

Hi, sorry for the delay!

Thanks for the insight, it works like a charm!

from ansible-doctor.

xoxys avatar xoxys commented on July 23, 2024

No worries, thanks for your feedback :)

from ansible-doctor.

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.