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

[DOCS] [FIX] Fix logging, typing and docstrings based on feedback #4968

Merged
merged 4 commits into from
Jun 6, 2024

Conversation

burtenshaw
Copy link
Contributor

@burtenshaw burtenshaw commented Jun 6, 2024

This PR introduces small fixes for logging, typing and docstrings based on feedback

Argilla Community Growers

Thanks for your contribution! As part of our Community Growers initiative 🌱, we're donating Justdiggit bunds in your name to reforest sub-Saharan Africa. To claim your Community Growers certificate, please contact David Berenstein in our Slack community or fill in this form https://tally.so/r/n9XrxK once your PR has been merged.

Pull Request Templates

Please go the the Preview tab and select the appropriate sub-template:

Generic Pull Request Template

Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.

Closes #<issue_number>

Type of change

(Please delete options that are not relevant. Remember to title the PR according to the type of change)

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (change restructuring the codebase without changing functionality)
  • Improvement (change adding some improvement to an existing functionality)
  • Documentation update

How Has This Been Tested

(Please describe the tests that you ran to verify your changes. And ideally, reference tests)

  • Test A
  • Test B

Checklist

  • I added relevant documentation
  • follows the style guidelines of this project
  • I did a self-review of my code
  • I made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I filled out the contributor form (see text above)
  • I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/)

@burtenshaw burtenshaw changed the title Docs/fix docs notes [DOCS] [FIX] Fix logging, typing and docstrings based on feedback Jun 6, 2024
@@ -23,6 +23,8 @@
"critical": logging.CRITICAL,
}

logger = logging.getLogger(name=__name__)
Copy link
Member

Choose a reason for hiding this comment

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

Does it make sense to tune the logger name to "argilla" or "argilla.sdk"? Logs can be confusing by providing this module name ("_log: ..."

Suggested change
logger = logging.getLogger(name=__name__)
logger = logging.getLogger(name="argilla")

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That makes sense. I'd say argilla.sdk then.

@burtenshaw burtenshaw merged commit ced3df2 into feat/v2.0.0 Jun 6, 2024
8 of 9 checks passed
@burtenshaw burtenshaw deleted the docs/fix-docs-notes branch June 6, 2024 11:32
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.

3 participants