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

Added doctest #614

Merged
merged 6 commits into from
Jun 6, 2023
Merged

Added doctest #614

merged 6 commits into from
Jun 6, 2023

Conversation

jesper-friis
Copy link
Collaborator

@jesper-friis jesper-friis commented Jun 3, 2023

Description

Added testing of examples in documentation using doctest.

We can now add examples to our docstrings and test that they actually works. Just format the docstring the standard way:

>>> from emmopy import get_emmo
>>> emmo = get_emmo().load()
>>> emmo.Atom
emmo.Atom

Also ignored some pytest warnings. I think that those that remain should be dealt with...

Type of change

  • Bug fix.
  • New feature.
  • Documentation update.
  • Test update.

Checklist

This checklist can be used as a help for the reviewer.

  • Is the code easy to read and understand?
  • Are comments for humans to read, not computers to disregard?
  • Does a new feature has an accompanying new test (in the CI or unit testing schemes)?
  • Has the documentation been updated as necessary?
  • Does this close the issue?
  • Is the change limited to the issue?
  • Are errors handled for all outcomes?
  • Does the new feature provide new restrictions on dependencies, and if so is this documented?

Comments

@codecov
Copy link

codecov bot commented Jun 3, 2023

Codecov Report

Merging #614 (4818e9a) into master (64b8e4e) will increase coverage by 0.12%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #614      +/-   ##
==========================================
+ Coverage   68.28%   68.41%   +0.12%     
==========================================
  Files          16       16              
  Lines        3172     3172              
==========================================
+ Hits         2166     2170       +4     
+ Misses       1006     1002       -4     
Impacted Files Coverage Δ
ontopy/manchester.py 92.22% <ø> (ø)
ontopy/patch.py 65.30% <ø> (ø)

... and 2 files with indirect coverage changes

@francescalb francescalb self-requested a review June 5, 2023 14:21
@jesper-friis jesper-friis merged commit 4487cc7 into master Jun 6, 2023
@jesper-friis jesper-friis deleted the doctest branch June 6, 2023 08:36
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