Skip to content

Fix incorrect docs URL for object conversion guide#901

Merged
petercrocker merged 2 commits intostablefrom
fix/object-conversion-docs-url
Mar 29, 2026
Merged

Fix incorrect docs URL for object conversion guide#901
petercrocker merged 2 commits intostablefrom
fix/object-conversion-docs-url

Conversation

@petercrocker
Copy link
Copy Markdown
Contributor

@petercrocker petercrocker commented Mar 29, 2026

Summary by CodeRabbit

  • Documentation
    • Updated documentation reference URLs for object conversion functionality to direct users to the correct guide pages.
  • Fix broken documentation URL in convert_node docstrings (both async and sync clients)
  • Changed /guides/object-convert-type/guides/object-conversion

Test plan

The docstrings for convert_node referenced /guides/object-convert-type
which doesn't exist. Updated to /guides/object-conversion.
@petercrocker petercrocker requested a review from a team as a code owner March 29, 2026 11:13
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 29, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 99d3882e-b433-4a5e-a0b2-5cd8cc545485

📥 Commits

Reviewing files that changed from the base of the PR and between 2c10bc2 and 046b85a.

📒 Files selected for processing (1)
  • docs/docs/python-sdk/sdk_ref/infrahub_sdk/client.mdx
✅ Files skipped from review due to trivial changes (1)
  • docs/docs/python-sdk/sdk_ref/infrahub_sdk/client.mdx

Walkthrough

This pull request updates documentation references in the Infrahub SDK. The referenced external guide URL for the convert_object_type() method documentation has been updated from https://docs.infrahub.app/guides/object-convert-type to https://docs.infrahub.app/guides/object-conversion. This change appears in both the method docstring in infrahub_sdk/client.py and the generated documentation file docs/docs/python-sdk/sdk_ref/infrahub_sdk/client.mdx. No changes were made to method signatures, logic, or error handling.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically summarizes the main change: fixing an incorrect documentation URL for the object conversion guide.
Description check ✅ Passed The description is minimal but covers the essential change (URL fix). However, it does not follow the provided template structure and lacks sections like behavioral impact, implementation notes, and deployment considerations.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages bot commented Mar 29, 2026

Deploying infrahub-sdk-python with  Cloudflare Pages  Cloudflare Pages

Latest commit: 046b85a
Status: ✅  Deploy successful!
Preview URL: https://7868d2fc.infrahub-sdk-python.pages.dev
Branch Preview URL: https://fix-object-conversion-docs-u.infrahub-sdk-python.pages.dev

View logs

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 29, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

@@           Coverage Diff           @@
##           stable     #901   +/-   ##
=======================================
  Coverage   80.68%   80.68%           
=======================================
  Files         119      119           
  Lines       10336    10336           
  Branches     1551     1551           
=======================================
  Hits         8340     8340           
  Misses       1473     1473           
  Partials      523      523           
Flag Coverage Δ
integration-tests 41.72% <ø> (ø)
python-3.10 51.82% <ø> (-0.02%) ⬇️
python-3.11 51.82% <ø> (-0.02%) ⬇️
python-3.12 51.82% <ø> (ø)
python-3.13 51.84% <ø> (ø)
python-3.14 53.52% <ø> (-0.02%) ⬇️
python-filler-3.12 24.04% <ø> (ø)

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

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

@github-actions github-actions bot added the type/documentation Improvements or additions to documentation label Mar 29, 2026
@petercrocker petercrocker force-pushed the fix/object-conversion-docs-url branch from 2c10bc2 to 046b85a Compare March 29, 2026 19:56
@petercrocker petercrocker merged commit 811ca9b into stable Mar 29, 2026
21 checks passed
@petercrocker petercrocker deleted the fix/object-conversion-docs-url branch March 29, 2026 22:04
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