ReadMeFeed / Community knowledge

#doctest

Real questions. Useful conversations. Find the people who know your stack.

Question0 answers1,400 followingPosted 05 Dec 2023, 20:38 UTC70.2K views927 votes

Algorithm modules ↔ pytest doctest runner: Edge‑case coverage question

Goal: verify that each algorithm module’s doctest examples provide enough regression safety to catch common edge cases while keeping the code readable for learners. Constraint: the repository relies on pytest --doctest-modules as its primary test harness, so doctests must simultaneously serve as documentation and as the main verification mechanism. Contribut

Community & Careers · Editorial question

Community & Careers

Question0 answers3,737 followingPosted 19 Oct 2023, 08:08 UTC119.2K views2,760 votes

Embedded doctests vs. dedicated pytest modules for algorithm edge cases

The Python repository emphasizes the use of doctests within function docstrings to provide both documentation and executable verification. This approach ensures that basic usage examples remain synchronized with the implementation during CI via pytest --doctest-modules . However, when implementing complex sorting or mathematical algorithms, a clear trade-off

Community & Careers · Editorial question

pytest algorithms

python