Skip to content

handler.py: Add docstring - #411

Merged
refeed merged 1 commit into
StackGuardian:mainfrom
Ankit-cs:docs/json-handler-docstring
Oct 21, 2026
Merged

refeed merged 1 commit into
StackGuardian:mainfrom
Ankit-cs:docs/json-handler-docstring

Conversation

@Ankit-cs

Copy link
Copy Markdown
Contributor

Related to #370

Pull Request Template

Description

  • What changes are being made?

    • Added standard reST-compliant docstrings (:param:, :returns:, :raises:) to all functions in src/tirith/providers/json/handler.py (get_value and provide).
    • Followed the strict one-file-per-PR contribution guideline with zero changes to existing execution logic.
  • Why are these changes necessary?

    • Functions in the JSON provider lacked docstrings. Adding standardized documentation improves code readability, developer experience, and aligns with the codebase-wide docstring initiative.
  • Which issues or tickets does this PR close or relate to?

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Other (please specify):

Checklist

  • Code has been linted.
  • Documentation has been updated (if needed).
  • Tests have been added or updated (if needed).
  • Any breaking changes have been communicated to the team.

Screenshots or Recordings (if applicable)

N/A

Additional Information

  • Formatted in accordance with Python reST docstring conventions.
  • Statically verified AST syntax validity (0 syntax errors).
  • Executed unit test suite for the JSON provider (test_unknown_operation_type_is_rejected, test_provide_get_value_success, test_provide_get_value_not_found) with 100% passing tests.

@Ankit-cs

Copy link
Copy Markdown
Contributor Author

looking for feedback @refeed

@Ankit-cs

Copy link
Copy Markdown
Contributor Author

Please look my pr for the above issue @refeed , @Akshat0694 , @arunim2405

@refeed refeed left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

lgtm, thanks :)

@refeed
refeed merged commit f441abd into StackGuardian:main Oct 21, 2026
8 checks passed
@refeed

refeed commented Oct 21, 2026

Copy link
Copy Markdown
Member

Thank you so much for this contribution @Ankit-cs!💙 We truly value the time and care you put into improving Tirith, and it means a lot to see the community help shape it. If you’re sharing your work on LinkedIn, don’t forget to tag StackGuardian so we can cheer you on! Keep them coming. We’re excited to see what you build next 😇

@codecov

codecov Bot commented Oct 21, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Files with missing lines Coverage Δ
src/tirith/providers/json/handler.py 100.00% <ø> (ø)
🚀 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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants