MemVerge/nf-float

Incorrect syntax example in README

Closed this issue · 1 comments

In your README there is the following example:

process sayHello {
  executor = 'float'
  image = 'cactus'
  cpu = 2
  mem = 4

  output:
    stdout

  """
  echo "Hello from NextFlow!"
  """
}

This syntax is incorrect, as process directives should be specified as e.g. executor 'float' rather than executor = 'float'. The assignment is only used for config syntax.

I'm guessing you tried it and it happens to work. That's partly Nextflow's fault for having a loosely-defined DSL syntax. But the point is that this syntax is not guaranteed to work, so we should try to avoid it.

The problem I see is that you are relying on this hack to support custom process directives. Most of them are deprecated or already supported by Nextflow, except for extra, which is useful for applying float-specific options to specific processes. We will need to find a way to support custom process directives properly in a plugin. For now, this hack will suffice.

Fix is merged. Thanks for the suggestion.