Skip to content

Added doctests for better documentation and testing#10

Merged
Ritunjai-Sharma merged 4 commits into
mainfrom
feature/add_doctests
Mar 20, 2026
Merged

Added doctests for better documentation and testing#10
Ritunjai-Sharma merged 4 commits into
mainfrom
feature/add_doctests

Conversation

@Ritunjai-Sharma

@Ritunjai-Sharma Ritunjai-Sharma commented Mar 10, 2026

Copy link
Copy Markdown
Contributor

PR for adding doctests to interpreter.py
Associated Issue: #11

The following work was done in this PR:

  • Referred to notebooks in the example folder and added doctests to functions in interpreter.py
  • Fixed a bug that I found while running doctests in interpreter.py.
  • Updated pyproject.toml to include doctests

Notes for Reviewer

@Ritunjai-Sharma Ritunjai-Sharma mentioned this pull request Mar 11, 2026
Comment thread model_interpreter/interpreter.py
@cjmwills cjmwills marked this pull request as ready for review March 13, 2026 09:09
@cjmwills

Copy link
Copy Markdown

S: can we add details of this change to the changelog?

@cjmwills

Copy link
Copy Markdown

Q: should we instead be merging back into feature/investigate_CI branch if that PR hasn't been approved yet?

Comment thread model_interpreter/interpreter.py
Comment thread model_interpreter/interpreter.py
Comment thread CHANGELOG.rst
@Ritunjai-Sharma

Copy link
Copy Markdown
Contributor Author

S: can we add details of this change to the changelog?

Added in this commit

@Ritunjai-Sharma

Copy link
Copy Markdown
Contributor Author

Q: should we instead be merging back into feature/investigate_CI branch if that PR hasn't been approved yet?

I was thinking of just pulling changes into this branch from master once feature/investigate_CI is merged in? That way we can still merge this branch into master?

@cjmwills

Copy link
Copy Markdown

I was thinking of just pulling changes into this branch from master once feature/investigate_CI is merged in? That way we can still merge this branch into master?

Sounds good, in that case though we won't want to merge this until that PR has gone in. Otherwise we'll be merging unreviewed code into main.

@Ritunjai-Sharma

Copy link
Copy Markdown
Contributor Author

I have now pulled latest changes from master into this branch in commit 9b8b3e8

@Ritunjai-Sharma Ritunjai-Sharma merged commit 6eea7f4 into main Mar 20, 2026
10 checks passed
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.

2 participants