Feature/3136 feature add more docstrings to pydantic models feedbackdataset

[davidberenstein1957]

Description

I noticed some missing Pydantic Docstring in the FeedbackDataset schemas.

• I added Pydantic Docstrings to the argilla/client/feedback/schemas.py
• Pydantic schemas were hinting towards filling them with ResponseSchema and ValueSchema, which feels weird if you need to import them separately from argilla.client.feedback.schemas
  • ResponseSchema is added to the argilla.__init__ imports
  • ValueSchema is added to the argilla.__init__ imports

Closes #3136

Type of change

• Refactor (change restructuring the codebase without changing functionality)
• Documentation update

How Has This Been Tested

N.A.

Checklist

• I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/)

[codecov]

Codecov Report

Patch coverage has no change and project coverage change: -0.01 ⚠️

Comparison is base (cec9473) 90.92% compared to head (ccc3927) 90.91%.

❗ Current head ccc3927 differs from pull request most recent head 6bd6fac. Consider uploading reports for the commit 6bd6fac to get more accurate results

Additional details and impacted files

@@                 Coverage Diff                 @@
##           releases/v1.9.0    #3137      +/-   ##
===================================================
- Coverage            90.92%   90.91%   -0.01%     
===================================================
  Files                  215      215              
  Lines                11312    11312              
===================================================
- Hits                 10285    10284       -1     
- Misses                1027     1028       +1     

Flag	Coverage Δ
pytest	90.91% <ø> (-0.01%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
src/argilla/__init__.py	83.33% <ø> (ø)
src/argilla/client/feedback/schemas.py	98.21% <ø> (ø)

... and 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[alvarobartt]

LGTM, thanks! But I'd add the default value in the docstrings, and use more generic examples (the comments below apply to all the occurrences)

[alvarobartt]

LGTM, but still some defaults are missing, settings should be removed from the schema init, and a minor change in the CHANGELOG.md 😄

[alvarobartt]

Here we're also missing the defaults! And in the rest of the schemas too!

[alvarobartt]

And I would remove the settings from everywhere, since the user is not able to modify them, so we can ignore them! Also in the next minor release we'll remove those, so either keep them as is and remove then in the next release, or remove them now to avoid confusion.