sciluigi icon indicating copy to clipboard operation
sciluigi copied to clipboard

Small fixes to the wiki

Open pietromarchesi opened this issue 8 years ago • 5 comments

I went through the 'Using' page of the wiki and found a few things that may need to be fixed.

  • Currently, the example replaces the foo string in foo.txt with bar, but then saves to foo.txt.bar.txt. I think it would make sense to save either to foo.txt or to bar.txt.
  • The ex() method uses in which is actually a keyword, and thus results in a syntax error. It also refers to self.out_bar() which has been renamed to self.out_replace() in the rest of the example.

I can fix this and submit a PR if needed?

pietromarchesi avatar Feb 01 '18 13:02 pietromarchesi

I can fix this and submit a PR if needed?

Absolutely, many thank in advance! :)

samuell avatar Feb 01 '18 17:02 samuell

Done! I also figured you need an extra slash in the sed command. Should work now!

pietromarchesi avatar Feb 02 '18 11:02 pietromarchesi

I was also wondering why you set

# Here we have one input, a "foo file":
in_foo = None

In MyFooReplacer, it seems to me that it's not necessary to set in_foo to None (at least, I see the logic of it, but the workflow ran fine without it).

pietromarchesi avatar Feb 02 '18 12:02 pietromarchesi

In MyFooReplacer, it seems to me that it's not necessary to set in_foo to None (at least, I see the logic of it, but the workflow ran fine without it).

Yeah, this is a practice we adopted mainly for documentary purposes, to make it clearer which are the in-ports for the task, and so that it would show up when using auto-completion in the editor, to aid when designing the workflows.

samuell avatar Feb 02 '18 13:02 samuell

Done!

Many thanks!

samuell avatar Feb 02 '18 13:02 samuell