Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: routine verification #76

Merged
merged 4 commits into from
Jun 25, 2024
Merged

feat: routine verification #76

merged 4 commits into from
Jun 25, 2024

Conversation

mstechly
Copy link
Contributor

Description

Closes #18

  • It required update to QREF 0.5.0.
  • Haven't checked if API docs render properly, still need to do that. Probably also might add some info about it to the tutorial.

Please verify that you have completed the following steps

  • I have self-reviewed my code.
  • I have included test cases validating introduced feature/fix.
  • I have updated documentation.

@mstechly mstechly requested a review from dexter2206 June 25, 2024 16:25
@cla-bot cla-bot bot added the cla-signed label Jun 25, 2024
return self.is_valid


def verify_routine_topology(routine: Routine) -> VerificationOutput:
Copy link
Contributor

Choose a reason for hiding this comment

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

issue (nonblocking): Missing Returns section. For the sake of how the docs look, I would add a simple paragraph like:

Returns:
    An object indicating if the verification succeeded, containing a (possibly empty) list of found problems.

return VerificationOutput(problems=verify_topology(qref_routine).problems)


def verify_uncompiled_routine(routine: Routine, backend: SymbolicBackend) -> VerificationOutput:
Copy link
Contributor

Choose a reason for hiding this comment

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

issue (nonblocking): Missing Returns section in docstrings.

return f"Couldn't parse {object_type}: {original_object} of subroutine: {path}."


def verify_compiled_routine(routine: Routine, backend: SymbolicBackend) -> VerificationOutput:
Copy link
Contributor

Choose a reason for hiding this comment

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

issue (nonblocking): Missing Returns section in docstring.

@mstechly mstechly merged commit cd1940d into main Jun 25, 2024
8 checks passed
@mstechly mstechly deleted the 18-routine-verification branch June 25, 2024 21:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

Add validation for Routine
2 participants