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.

Sign up for GitHub

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

Jump to bottom

Clean up readme #484

Merged
merged 1 commit into from
Jan 10, 2025
Merged

Clean up readme #484

merged 1 commit into from
Jan 10, 2025

Conversation

harisang
Copy link
Contributor

@harisang harisang commented Jan 8, 2025

This PR updates and cleans up a bit the readme file.

@harisang harisang requested a review from fhenneke January 8, 2025 14:19
bh2smith
bh2smith approved these changes Jan 8, 2025
View reviewed changes
Copy link
Contributor

@bh2smith bh2smith left a comment

Choose a reason for hiding this comment

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

Looks legit. Seems to be a bit of overlap with post-tx and dry-run

@harisang
Copy link
Contributor Author

harisang commented Jan 9, 2025 •
edited
Loading

Seems to be a bit of overlap with post-tx and dry-run

Good point. Might add some more details, or potentially even drop one of the two flags

fhenneke
fhenneke approved these changes Jan 9, 2025
View reviewed changes
Copy link
Collaborator

@fhenneke fhenneke left a comment

Choose a reason for hiding this comment

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

Looks reasonable.

It looks as if you are not copying the result of the command python -m src.fetch.transfer_file --help but instead manually modified the readme. This messes up the alignment and line breaks.

@fhenneke fhenneke merged commit 84931af into main Jan 10, 2025
6 checks passed
@fhenneke fhenneke deleted the fix_readme_issue branch January 10, 2025 15:29
@github-actions github-actions bot locked and limited conversation to collaborators Jan 10, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@bh2smith bh2smith bh2smith approved these changes

@fhenneke fhenneke fhenneke approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@harisang @fhenneke @bh2smith