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

[Feature] Clarity in Readme file for noop transform #123

Open
1 of 2 tasks
shahrokhDaijavad opened this issue May 13, 2024 · 1 comment
Open
1 of 2 tasks

[Feature] Clarity in Readme file for noop transform #123

shahrokhDaijavad opened this issue May 13, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request fixed Marks an issues as fixed in the dev branch

Comments

@shahrokhDaijavad
Copy link
Member

Search before asking

  • I searched the issues and found no similar issues.

Component

Transforms/universal/noop

Feature

Clarity requested by Dean in: data-prep-kit/transforms/universal/noop/README.md

Can you provide more explanation about what the configuration values, do, e.g.,
• noop_sleep_sec : specifies the number of seconds to sleep during table transformation. What does "during" mean. Is it really before or after processing starts? Is this something "real" transformers might want, e.g., to allow something to happen in the background before reading starts?
• noop_pwd - specifies a dummy password not included in metadata. I assume this is for accessing the file. Is a user name also required?

Of course, you said these are examples, but I would go to extra effort to clarify specific behaviors, to encourage users to do the same.
As a general note about configuration parameter names, would it be better to use a hierarchy, like noop.sleep.sec so that in the noop context, you would just look at sleep.sec in the config file. I made sleep a parent in case you added more options, e.g.,
noop.sleep.enable = false
noop.sleep.sec = 2

Are you willing to submit a PR?

  • Yes I am willing to submit a PR!
@shahrokhDaijavad shahrokhDaijavad added the enhancement New feature or request label May 13, 2024
@daw3rd
Copy link
Member

daw3rd commented May 14, 2024

I have since added/merged some more details on this parameters. I'll mark this fixed for now, but @deanwampler can verify.

@daw3rd daw3rd added the fixed Marks an issues as fixed in the dev branch label May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request fixed Marks an issues as fixed in the dev branch
Projects
None yet
Development

No branches or pull requests

2 participants