Skip to content

Document proofs include value for get_sheet#161

Merged
smar-ivan-sandev merged 1 commit into
mainlinefrom
add-proofs-getsheet-docstring
Jul 21, 2026
Merged

Document proofs include value for get_sheet#161
smar-ivan-sandev merged 1 commit into
mainlinefrom
add-proofs-getsheet-docstring

Conversation

@smar-ivan-sandev

@smar-ivan-sandev smar-ivan-sandev commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Adds proofs to the documented valid include values for get_sheet, completing the proofs work started in #159.

The Proof model, Row.proof, and the get_report docstring already listed proofs (shipped in #159); the get_sheet docstring was the remaining gap. include is passed through, so include=['proofs'] already worked at runtime — this is a docs-only fix.

DEVECO-2197

Summary by CodeRabbit

  • Documentation
    • Updated the Sheets.get_sheet documentation to list proofs as a valid include option.

@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 9610fb85-8c1f-4497-9b62-a157c8b20279

📥 Commits

Reviewing files that changed from the base of the PR and between f57835f and 4dcee70.

📒 Files selected for processing (1)
  • smartsheet/sheets.py

📝 Walkthrough

Walkthrough

The get_sheet docstring now lists proofs among the valid include parameter values. No request, response, or API behavior changed.

Changes

Sheet API documentation

Layer / File(s) Summary
Update get_sheet include values
smartsheet/sheets.py
The include parameter documentation now includes proofs as a valid value.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: astrinski-smartsheet, ggoranov-smar

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description covers the basic change and rationale, but it misses most template sections like type, environment, testing, and checklist. Add the missing template sections: Type of Change, Environment Information, What Changes Were Made, Testing, Checklist, and any Additional Notes.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately summarizes the docs-only change to the get_sheet proofs include value.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch add-proofs-getsheet-docstring

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

@coveralls

Copy link
Copy Markdown

Coverage Report for CI Build 29828647042

Warning

No base build found for commit f57835f on mainline.
Coverage changes can't be calculated without a base build.
If a base build is processing, this comment will update automatically when it completes.

Coverage: 77.908%

Details

  • Patch coverage: No coverable lines changed in this PR.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

Requires a base build to compare against. How to fix this →


Coverage Stats

Coverage Status
Relevant Lines: 10963
Covered Lines: 8541
Line Coverage: 77.91%
Coverage Strength: 3.9 hits per line

💛 - Coveralls

@smar-ivan-sandev
smar-ivan-sandev merged commit c830825 into mainline Jul 21, 2026
13 checks passed
@smar-ivan-sandev
smar-ivan-sandev deleted the add-proofs-getsheet-docstring branch July 21, 2026 18:41
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.

3 participants