Skip to content

Add raises section to existing docstrings#1009

Draft
ogenstad wants to merge 1 commit intostablefrom
pog-doc501
Draft

Add raises section to existing docstrings#1009
ogenstad wants to merge 1 commit intostablefrom
pog-doc501

Conversation

@ogenstad
Copy link
Copy Markdown
Contributor

Why

  • Gives the callers a better view of what might happen when calling this code
  • Can be used by AI agents to better understand when an error could be raised.

What changed

  • Add missing raises section to current docstrings
  • Enable ruff rule DOC501 in pyproject.toml

@github-actions github-actions Bot added the type/documentation Improvements or additions to documentation label May 10, 2026
@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying infrahub-sdk-python with  Cloudflare Pages  Cloudflare Pages

Latest commit: a186271
Status: ✅  Deploy successful!
Preview URL: https://44e1448f.infrahub-sdk-python.pages.dev
Branch Preview URL: https://pog-doc501.infrahub-sdk-python.pages.dev

View logs

@codecov
Copy link
Copy Markdown

codecov Bot commented May 10, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

@@           Coverage Diff           @@
##           stable    #1009   +/-   ##
=======================================
  Coverage   81.41%   81.41%           
=======================================
  Files         134      134           
  Lines       11347    11347           
  Branches     1703     1703           
=======================================
  Hits         9238     9238           
  Misses       1566     1566           
  Partials      543      543           
Flag Coverage Δ
integration-tests 41.84% <ø> (-0.01%) ⬇️
python-3.10 54.34% <ø> (ø)
python-3.11 54.36% <ø> (ø)
python-3.12 54.34% <ø> (-0.02%) ⬇️
python-3.13 54.36% <ø> (ø)
python-3.14 54.34% <ø> (-0.02%) ⬇️
python-filler-3.12 22.74% <ø> (ø)

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

Files with missing lines Coverage Δ
infrahub_sdk/_importer.py 91.42% <ø> (ø)
infrahub_sdk/client.py 74.58% <ø> (ø)
infrahub_sdk/config.py 91.13% <ø> (ø)
infrahub_sdk/graphql/query_renderer.py 97.70% <ø> (ø)
infrahub_sdk/graphql/utils.py 73.80% <ø> (ø)
infrahub_sdk/node/node.py 85.91% <ø> (ø)
infrahub_sdk/node/parsers.py 63.63% <ø> (ø)
infrahub_sdk/node/relationship.py 79.67% <ø> (ø)
infrahub_sdk/object_store.py 71.24% <ø> (ø)
infrahub_sdk/pytest_plugin/items/base.py 78.37% <ø> (ø)
... and 7 more
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type/documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant