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

Implement doctests in CI #211

Merged
merged 2 commits into from
Jun 24, 2022
Merged

Conversation

Saransh-cpp
Copy link
Member

@Saransh-cpp Saransh-cpp commented Jun 24, 2022

Closes #208

  • Add xdoctests to test dependepncies
  • Fix the already written doctests and make them deterministic
  • Run doctests in the CI

@Saransh-cpp Saransh-cpp marked this pull request as draft June 24, 2022 09:27
@Saransh-cpp Saransh-cpp marked this pull request as ready for review June 24, 2022 12:51
@Saransh-cpp Saransh-cpp merged commit ba4e8b4 into scikit-hep:main Jun 24, 2022
@Saransh-cpp Saransh-cpp deleted the saransh/doctests branch June 24, 2022 12:56
>>> a = vector.Array(
... [{"px": 1, "py": 1.1, "z": 0.1, "m": 1}, {"px": 2, "py": 2.2, "z": 0.2, "m": 3}],
... )
>>> a.longitudinal
<vector.backends.awkward.LongitudinalAwkwardZ object at 0x0000028231215A80>
Copy link
Member

Choose a reason for hiding this comment

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

I thought xdoctest recognized the pointers here in an object default repr and still compared correctly? (not sure it's important to show, but just thinking it should have worked if that's the problem)

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, locally xdoctest fails the doctests on these outputs. I will get them up in the PR closing #209!

@Saransh-cpp Saransh-cpp added this to the v0.9.0 milestone Feb 17, 2023
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.

Run doctests
2 participants