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 examples for RequestBody #2415

Merged
merged 2 commits into from
Jan 8, 2025
Merged

Conversation

xavierleune
Copy link
Contributor

Hi,

this is my first try with this bundle and I got into an error that leads me to a discussion on github. Following the discussion here: #1990 (comment) I think that the documentation should be updated to match the "content" argument.
But maybe I've missed something else ?

Thanks !

What type of PR is this? (check all applicable)

  • Bug Fix
  • Feature
  • Refactor
  • Deprecation
  • Breaking Change
  • Documentation Update
  • CI

Checklist

  • I have made corresponding changes to the documentation (docs/)
  • I have made corresponding changes to the changelog (CHANGELOG.md)

Copy link
Collaborator

@DjordyKoert DjordyKoert left a comment

Choose a reason for hiding this comment

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

The documentation for annotations are correct

docs/index.rst Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
@DjordyKoert
Copy link
Collaborator

Thank you for the PR, seems like the documentation has always been incorrect here for attributes

@DjordyKoert DjordyKoert changed the title Fix examples for RequestBody docs: fix examples for RequestBody Jan 7, 2025
@xavierleune
Copy link
Contributor Author

@DjordyKoert thanks for your feedback, I should have been more careful about the annotations ^^

Copy link

codecov bot commented Jan 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.53%. Comparing base (ff91395) to head (9ea8657).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2415   +/-   ##
=======================================
  Coverage   89.53%   89.53%           
=======================================
  Files          78       78           
  Lines        2915     2915           
=======================================
  Hits         2610     2610           
  Misses        305      305           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@DjordyKoert DjordyKoert left a comment

Choose a reason for hiding this comment

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

Thanks a lot :)

@DjordyKoert DjordyKoert merged commit 13408ab into nelmio:master Jan 8, 2025
25 checks passed
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