Skip to content

fix: update docstrings with correct status code#333

Open
saathviksheerla wants to merge 1 commit into
openml:mainfrom
saathviksheerla:fix/runs-trace-test-docstrings
Open

fix: update docstrings with correct status code#333
saathviksheerla wants to merge 1 commit into
openml:mainfrom
saathviksheerla:fix/runs-trace-test-docstrings

Conversation

@saathviksheerla

@saathviksheerla saathviksheerla commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Fixes #332

  • updated the docstrings in tests to reflect the new Python API implementation(412 to 404)

Checklist

Always:

  • I have performed a self-review of my own pull request to ensure it contains all relevant information, and the proposed changes are minimal but sufficient to accomplish their task.

Required for code changes:

  • Tests pass locally
  • I have commented my code in hard-to-understand areas, and provided or updated docstrings as needed
  • Changes are already covered under existing tests

@coderabbitai

coderabbitai Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

This PR updates test docstrings in tests/routers/openml/runs_trace_test.py to document the correct HTTP status behavior. Two test cases—test_get_run_trace_no_trace and test_get_run_trace_run_not_found—had their docstrings changed to reflect that the endpoint returns HTTP 404 rather than HTTP 412 for both "run not found" and "run has no trace" scenarios. No test logic or assertions were modified.

Possibly related PRs

  • openml/server-api#272: Updates the same /run/trace/{run_id} test docstrings to reflect the endpoint's actual HTTP 404 status behavior for missing runs and traces.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: updating docstrings to reflect the correct HTTP status code from 412 to 404.
Linked Issues check ✅ Passed The pull request successfully addresses issue #332 by updating docstrings in tests/routers/openml/runs_trace_test.py to reflect HTTP 404 instead of 412 for run/trace not found scenarios.
Out of Scope Changes check ✅ Passed All changes are in scope and directly address the linked issue #332; only docstrings were updated with no test logic or extraneous modifications introduced.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Description check ✅ Passed The pull request description clearly references issue #332 and accurately describes the changes made: updating docstrings to reflect the correct HTTP status code (404 instead of 412).

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov

codecov Bot commented Jun 11, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.66%. Comparing base (c22d716) to head (b27fdb9).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #333      +/-   ##
==========================================
- Coverage   94.69%   94.66%   -0.04%     
==========================================
  Files          70       70              
  Lines        3281     3281              
  Branches      230      230              
==========================================
- Hits         3107     3106       -1     
  Misses        113      113              
- Partials       61       62       +1     

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

🚀 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

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix docstring for GET run/trace/{id} endpoint in tests

1 participant