Features lacking documentation in various places

[lauri...@gmail.com]

I thought it would be good to have a thread for improving documentation. If you notice code or options that lack documentation in the place you would expect to find it, report it here.

Contents of this discussion can also become their standalone threads in cases where they demonstrate how to use Anduril.

[lauri...@gmail.com]

Renaming output filenames

In Anduril, output port files can be renamed. How this is done is not described in the user guide. This is a test pipeline demonstrating the feature. Output port filenames of two StringInput components and an OUTPUT component are renamed.

@out.in.filename = "numberTwo.csv" // Notice that in is the *output's* name. Without using this annotation, the output filename would be called "in"
x = StringInput(content="2")

@out.in.filename = "second"
y = StringInput(content="2")

@out.out.filename = "numberTwoOUTPUT.csv"
OUTPUT(x.in)

Output looks like:

result_fnann/
├── output
│   └── numberTwoOUTPUT.csv
├── _state
├── x
│   ├── _command
│   ├── _launch
│   └── numberTwo.csv
└── y
    ├── _command
    ├── _launch
    └── second

[Ville Rantanen]

you could've just added this in the user guide :D 

[lauri...@gmail.com]

Problem is I don't know (TM) or recall how the feature works, if there was something else to it, etc. Maybe there's something else. Who wrote it, anyway (yes, could check the edit logs)? And, a discussion may be useful anyway, because it doesn't hurt to have the information here as well. Also theoretically it may be in the user guide, but I just didn't find it :)