question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Multi-line strings in meta, parameter_meta

See original GitHub issue

If we want to put rich information in there, we should allow >1 line of text. We could maybe re-use the triple-angle brackets style, eg:

workflow foo {
  meta {
    description: <<<
      # Foo.wdl
      ---
      This could be a looo...
      ...
      ...
      ...oong Markdown description of the workflow, for example
    >>>
  }
}

Issue Analytics

  • State:open
  • Created 5 years ago
  • Reactions:2
  • Comments:5 (3 by maintainers)

github_iconTop GitHub Comments

1reaction
aednicholscommented, Jun 18, 2018

👍 to the idea of adding the multi-line string literal and thereby gaining the ability to use it in meta

Longer term, it seems like we could go in a Javadoc-like direction where documentation is in comments adjacent to the thing it describes.

This would let us generate documentation from the workflow with a documenting tool, but would exclude the documentation strings from appearing anywhere at runtime. (Engine-specific hints would still live in *meta.)

1reaction
ambrosejcarrcommented, Jun 18, 2018

We in Mint need some kind of abstraction that allows us to add documentation to WDL files. We’re currently using meta and parameter_meta to do this, as there doesn’t appear to be a better alternative.

Without multi-line strings, they make our files pretty hideous, so big 👍 on this issue.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Using a Jenkins pipeline multiline /multi-line string parameter
I discovered the solution by looking at the Jenkins source code: parameters{ text(name: 'mytextparam', defaultValue: 'Default lines for the ...
Read more >
Template literals (Template strings) - JavaScript | MDN
Template literals are literals delimited with backtick (`) characters, allowing for multi-line strings, string interpolation with embedded ...
Read more >
Metadata format: metadata is not a plain mapping of strings
Almost all build backends assume metadata to be a plain mapping of strings (distutils, setuptools, flit, poetry, etc.)
Read more >
LLVM Language Reference Manual
Metadata nodes (but not metadata strings) are the only valid operands for a named metadata. Named metadata are represented as a string of...
Read more >
Writing YARA rules — yara 4.2.0 documentation
This is a multi-line comment . ... This limitation does not apply to strings in the metadata section or comments. ... The alphabet...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found