Skip to content

docs: add missing docstrings to spec_evaluator.py (fix #442)#859

Open
lipikaparida-web wants to merge 1 commit intoscanapi:mainfrom
lipikaparida-web:fix-442-docstrings
Open

docs: add missing docstrings to spec_evaluator.py (fix #442)#859
lipikaparida-web wants to merge 1 commit intoscanapi:mainfrom
lipikaparida-web:fix-442-docstrings

Conversation

@lipikaparida-web
Copy link

Description

Added missing docstrings to scanapi/evaluators/spec_evaluator.py.

Motivation behind this PR?

This improves code readability and documentation quality by adding docstrings to public methods and helper functions, as requested in issue #442.

What type of change is this?

Documentation change (docstrings only). No functional changes.

Checklist

  • A changelog entry was added, or this PR does not require one. (Docstring-only change)
  • Unit tests were added or updated as needed, or not required for this change. (Not required)
  • All unit tests pass locally. (Not run; docstring-only change)
  • Docstrings or comments were added or updated as needed.
  • This PR does not significantly reduce code or docstring coverage.
  • Code follows the project's style guidelines.
  • ScanAPI was run locally and the changes were manually verified, or this was not necessary. (Not necessary for docstring-only change)

Issue

Fixes #442

@lipikaparida-web lipikaparida-web requested review from a team as code owners January 19, 2026 19:22
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Thank you for supporting ScanAPI, and congratulations on your first contribution! A project committer will shortly review your contribution.

In the mean time, if you haven't had a chance please skim over the First Pull Request Guide which all pull requests must adhere to.

We hope to see you around!

@github-actions github-actions bot added the First Contribution First contribution to the project. label Jan 19, 2026
@lipikaparida-web
Copy link
Author

Hi maintainers 👋

I’ve opened a PR to add the missing docstrings to spec_evaluator.py.

PR: #859

Thanks!

@lipikaparida-web lipikaparida-web changed the title Add missing docstrings to spec_evaluator.py (Fix #442) docs: add missing docstrings to spec_evaluator.py (fix #442) Jan 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

First Contribution First contribution to the project.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add the missing docstrings to the spec_evaluator.py file

1 participant