This pull request enhances the documentation across various modules in the trippy-core crate, focusing on improving the clarity and completeness of the documentation for public structs, traits, and functions.
Adds comprehensive documentation to the Builder struct in builder.rs, including examples, errors, and panics information.
Updates the Channel struct in net/channel.rs with detailed documentation, including a one-line summary, comprehensive description, examples, and details of errors and panics.
Enhances the Probe and ProbeComplete structs in probe.rs with detailed documentation, including examples and comprehensive descriptions.
Documents the Network trait in net.rs with a one-line summary, comprehensive description, examples, and details of errors and panics.
Improves the Platform trait documentation in net/platform.rs with a one-line summary, comprehensive description, examples, and details of errors and panics.
These changes aim to make the trippy-core crate's documentation more informative and useful for developers, adhering to the task's goal of improving documentation quality.
This pull request enhances the documentation across various modules in the
trippy-corecrate, focusing on improving the clarity and completeness of the documentation for public structs, traits, and functions.Builderstruct inbuilder.rs, including examples, errors, and panics information.Channelstruct innet/channel.rswith detailed documentation, including a one-line summary, comprehensive description, examples, and details of errors and panics.ProbeandProbeCompletestructs inprobe.rswith detailed documentation, including examples and comprehensive descriptions.Networktrait innet.rswith a one-line summary, comprehensive description, examples, and details of errors and panics.Platformtrait documentation innet/platform.rswith a one-line summary, comprehensive description, examples, and details of errors and panics.These changes aim to make the
trippy-corecrate's documentation more informative and useful for developers, adhering to the task's goal of improving documentation quality.For more details, open the Copilot Workspace session.