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

Create README.md #25

Merged
merged 12 commits into from
Mar 13, 2025
Merged

Create README.md #25

merged 12 commits into from
Mar 13, 2025

Conversation

leoberhelman
Copy link
Contributor

@leoberhelman leoberhelman commented Mar 6, 2025

This pull request handles the read me and the --help option with the specific instructions for singular functions

@leoberhelman leoberhelman self-assigned this Mar 6, 2025
Copy link
Collaborator

@atteggiani atteggiani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @leoberhelman for working on this.
The structure looks good and the "TO BE ADDED" parts can be dealt with in the future.

Apart from the specific suggestions, as I mentioned in some comments, it might be useful to add some more detailed description and examples within each of the parsers.

@leoberhelman
Copy link
Contributor Author

I added the usage to the descriptions of the parsers, and now it can be accessed with --help. I also added a list of required software to include mule.

@leoberhelman leoberhelman requested a review from atteggiani March 13, 2025 04:03
@atteggiani atteggiani marked this pull request as ready for review March 13, 2025 05:15
leoberhelman and others added 11 commits March 13, 2025 17:19
Update README.md

Seperated the usage case

Update README.md

Update README.md

Add the usage for the change_dump_date

Update README.md

Update README.md

Co-authored-by: Davide Marchegiani <[email protected]>

Update README.md

Co-authored-by: Davide Marchegiani <[email protected]>

Update README.md

Co-authored-by: Davide Marchegiani <[email protected]>

Update README.md

Co-authored-by: Davide Marchegiani <[email protected]>

Update README.md

Co-authored-by: Davide Marchegiani <[email protected]>

Update README.md

Co-authored-by: Davide Marchegiani <[email protected]>

Update README.md

Co-authored-by: Davide Marchegiani <[email protected]>
Update README.md
added the help functions
Added the --help to the fields subset

Update um_fields_subset.py

Added the usage to the description
added a usage to the --help
Copy link
Collaborator

@atteggiani atteggiani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @leoberhelman

I rebased to main and made a few adjustments.
Good to be merged!

@atteggiani atteggiani merged commit 997e37a into main Mar 13, 2025
3 checks passed
@atteggiani atteggiani deleted the lindsey/Readme branch March 13, 2025 06:21
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

Successfully merging this pull request may close these issues.

2 participants