Skip to content

Add docstrings to related node#1000

Open
ogenstad wants to merge 1 commit into
stablefrom
pog-add-related-node-docstrings
Open

Add docstrings to related node#1000
ogenstad wants to merge 1 commit into
stablefrom
pog-add-related-node-docstrings

Conversation

@ogenstad
Copy link
Copy Markdown
Contributor

@ogenstad ogenstad commented May 8, 2026

Why

Adding docstrings, specifically for the Raises part to assist linters, people navigating the code and AI agents to understand the code in a quicker way.

Making this change as it was something that confused Claude and had it try to introduce errors.

What changed

  • Added docstrings

@codecov
Copy link
Copy Markdown

codecov Bot commented May 8, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

@@           Coverage Diff           @@
##           stable    #1000   +/-   ##
=======================================
  Coverage   81.71%   81.71%           
=======================================
  Files         135      135           
  Lines       11626    11626           
  Branches     1759     1759           
=======================================
  Hits         9500     9500           
  Misses       1575     1575           
  Partials      551      551           
Flag Coverage Δ
integration-tests 41.57% <ø> (-0.01%) ⬇️
python-3.10 55.09% <ø> (ø)
python-3.11 55.09% <ø> (ø)
python-3.12 55.10% <ø> (ø)
python-3.13 55.09% <ø> (-0.02%) ⬇️
python-3.14 55.08% <ø> (-0.02%) ⬇️
python-filler-3.12 22.38% <ø> (ø)

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

Files with missing lines Coverage Δ
infrahub_sdk/node/related_node.py 92.44% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ogenstad ogenstad force-pushed the pog-add-related-node-docstrings branch from 86e3dbb to f3b35d2 Compare May 8, 2026 13:47
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented May 8, 2026

Deploying infrahub-sdk-python with  Cloudflare Pages  Cloudflare Pages

Latest commit: 302569d
Status: ✅  Deploy successful!
Preview URL: https://ee468c7a.infrahub-sdk-python.pages.dev
Branch Preview URL: https://pog-add-related-node-docstri.infrahub-sdk-python.pages.dev

View logs

@github-actions github-actions Bot added the type/documentation Improvements or additions to documentation label May 8, 2026
@ogenstad ogenstad force-pushed the pog-add-related-node-docstrings branch from f3b35d2 to 5e59d95 Compare June 2, 2026 13:56
@ogenstad ogenstad force-pushed the pog-add-related-node-docstrings branch from 5e59d95 to 302569d Compare June 2, 2026 13:59
@ogenstad ogenstad marked this pull request as ready for review June 2, 2026 17:19
@ogenstad ogenstad requested a review from a team as a code owner June 2, 2026 17:19
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.

2 participants