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

Added example to mixeup docstring #1576

Merged
merged 4 commits into from
Mar 12, 2024
Merged

Added example to mixeup docstring #1576

merged 4 commits into from
Mar 12, 2024

Conversation

ternaus
Copy link
Collaborator

@ternaus ternaus commented Mar 12, 2024

No description provided.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ternaus - I've reviewed your changes and they look great!

General suggestions:

  • Consider adding a note about the importance of using meaningful and representative data in real-world applications to the example section. This could help users understand the impact of input data quality on augmentation effectiveness.
  • For the read_fn parameter, it might be beneficial to mention or provide an example for more complex use cases where data is not already in the expected format. This could guide users in implementing more sophisticated functions for their specific needs.
Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Docstrings: all looks good

Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨

Share Sourcery

Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

ternaus and others added 3 commits March 11, 2024 17:46
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@ternaus ternaus merged commit a4b9606 into main Mar 12, 2024
17 checks passed
@ternaus ternaus deleted the add_example_to_dosctring branch March 12, 2024 01:24
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.

1 participant