Skip to content

Fix mkdocstrings inventory example in documentation#11311

Merged
Viicos merged 1 commit intopydantic:mainfrom
pawamoy:patch-1
Jan 21, 2025
Merged

Fix mkdocstrings inventory example in documentation#11311
Viicos merged 1 commit intopydantic:mainfrom
pawamoy:patch-1

Conversation

@pawamoy
Copy link
Copy Markdown
Contributor

@pawamoy pawamoy commented Jan 21, 2025

Change Summary

Fix a documentation error about loading object inventories with mkdocstrings.

Related issue number

#11289, #11291

Checklist

  • The pull request title is a good summary of the changes - it will be used in the changelog
  • Unit tests for the changes exist
  • Tests pass on CI
  • Documentation reflects the changes where applicable
  • My PR is ready to review, please add a comment including the phrase "please review" to assign reviewers

Please review!

@github-actions github-actions Bot added the relnotes-fix Used for bugfixes. label Jan 21, 2025
@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented Jan 21, 2025

CodSpeed Performance Report

Merging #11311 will not alter performance

Comparing pawamoy:patch-1 (08f436d) with main (a3fd33f)

Summary

✅ 45 untouched benchmarks

@github-actions
Copy link
Copy Markdown
Contributor

Coverage report

This PR does not seem to contain any modification to coverable code.

@Viicos Viicos changed the title docs: Fix mkdocstrings example Fix mkdocstrings inventory example in documentation Jan 21, 2025
Copy link
Copy Markdown
Member

@Viicos Viicos left a comment

Choose a reason for hiding this comment

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

Thanks, that was hard to get right 😅

@Viicos Viicos merged commit e400287 into pydantic:main Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

relnotes-fix Used for bugfixes.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants