Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Small fixes to the wiki #46

Open
pietromarchesi opened this issue Feb 1, 2018 · 5 comments
Open

Small fixes to the wiki #46

pietromarchesi opened this issue Feb 1, 2018 · 5 comments

Comments

@pietromarchesi
Copy link
Contributor

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?

@samuell
Copy link
Member

samuell commented Feb 1, 2018

I can fix this and submit a PR if needed?

Absolutely, many thank in advance! :)

@pietromarchesi
Copy link
Contributor Author

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

@pietromarchesi
Copy link
Contributor Author

pietromarchesi commented Feb 2, 2018

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).

@samuell
Copy link
Member

samuell commented Feb 2, 2018

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
Copy link
Member

samuell commented Feb 2, 2018

Done!

Many thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants