Skip to content

Make pytest run doctests#280

Merged
jstasiak merged 2 commits intomasterfrom
pytest-doctests
Dec 14, 2023
Merged

Make pytest run doctests#280
jstasiak merged 2 commits intomasterfrom
pytest-doctests

Conversation

@jstasiak
Copy link
Contributor

This includes doctests found in the docstrings in the code and doctests from the .rst files.

We currently don't have either in the code but I intend to add some and I'd like this piece of infrastructure in place first.

This includes doctests found in the docstrings in the code and doctests
from the .rst files.

We currently don't have either in the code but I intend to add some and
I'd like this piece of infrastructure in place first.
@jstasiak jstasiak merged commit 3290b50 into master Dec 14, 2023
@jstasiak jstasiak deleted the pytest-doctests branch December 14, 2023 15:24
jstasiak added a commit that referenced this pull request Dec 15, 2023
This is one of the pieces missing to have a good IPv4-mapped IPv6
address handling story.

Following Rust's IpAddr::to_canonical() design[1][2][3] which seems
sensible to me (except that ours is simpler as we don't have separate
types for IPv4 and IPv6 addresses – yet).

Also, relying on doctests[4] to test this feature – no need to make things
more difficult than they need to be.

[1] https://doc.rust-lang.org/std/net/enum.IpAddr.html#method.to_canonical
[2] https://doc.rust-lang.org/std/net/struct.Ipv6Addr.html#method.to_canonical
[3] rust-lang/rust#87708
[4] 3290b50 ("Make pytest run doctests (#280)")
jstasiak added a commit that referenced this pull request Dec 15, 2023
This is one of the pieces missing to have a good IPv4-mapped IPv6
address handling story.

Following Rust's IpAddr::to_canonical() design[1][2][3] which seems
sensible to me (except that ours is simpler as we don't have separate
types for IPv4 and IPv6 addresses – yet).

Also, relying on doctests[4] to test this feature – no need to make things
more difficult than they need to be.

[1] https://doc.rust-lang.org/std/net/enum.IpAddr.html#method.to_canonical
[2] https://doc.rust-lang.org/std/net/struct.Ipv6Addr.html#method.to_canonical
[3] rust-lang/rust#87708
[4] 3290b50 ("Make pytest run doctests (#280)")
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.

1 participant