Skip to content

feat(doctest): expand doctests #35

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

Merged
merged 3 commits into from
Dec 8, 2023
Merged

Conversation

royveshovda
Copy link
Contributor

Update doctests to include example string first.

Might be only my personal flow. I usually start with the example string, before I tackle the main input

@mathsaey
Copy link
Owner

mathsaey commented Dec 8, 2023

That is a good catch; the generated doctests should have called example_string from the get go, but it seems I messed up.

I did make two changes though:

  1. I also updated the cheatsheet, as it also showed the wrong function call.
  2. I removed the extra comments you've added, as I don't think they're needed. If no result is provided, the doctest will accept anything (so it won't cause errors; right now it does due to the call to example_input).

Let me know if this is okay to you and I will push a new version to hex later today!

@royveshovda
Copy link
Contributor Author

Looks all good to me. Thanks for a very useful set of tools, btw.

@mathsaey mathsaey merged commit 6db35af into mathsaey:master Dec 8, 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.

2 participants