Highlight signature of flux-commands

metafacture / metafacture-documentation

The central place for documentation about metafacture

http://metafacture.github.io/metafacture-documentation/

Apache License 2.0

3 stars 3 forks source link

Highlight signature of flux-commands #16

Open TobiasNx opened 2 years ago

TobiasNx commented 2 years ago

The signature is the central info when constructing an FLUX workflow it shows which input is needed and what output is created by an modul. This gives orientation which modul can be combined. It should be highlighted so one can combiner flux moduls more easily.

change-id
---------
- description:  By default changes the record ID to the value of the '_id' literal (if present). Use the contructor to choose another literal as ID source.
- options:  keepidliteral (boolean), idliteral (String), keeprecordswithoutidliteral (boolean)
- signature:    StreamReceiver -> StreamReceiver
- java class:   org.metafacture.mangling.RecordIdChanger

TobiasNx commented 2 years ago

Ideas:

sort all moduls by input
split singnature to in and out
work with color highlighting
set as first attribute

dr0i commented 10 months ago

I don't understand the ideas - an example would be good.

TobiasNx commented 6 days ago

The idea was something like this: but I am not sure anymore.

change-id
---------
- description:  By default changes the record ID to the value of the '_id' literal (if present). Use the contructor to choose another literal as ID source.
- options:  keepidliteral (boolean), idliteral (String), keeprecordswithoutidliteral (boolean)
- in:   StreamReceiver
- out: StreamReceiver
- java class:   org.metafacture.mangling.RecordIdChanger

perhaps::

- signature: in: StreamReceiver -> out: StreamReceiver

would be enough, that would help when searching the documentation.

@dr0i what do you think?