Updates documentation and adds tests to improve the public API of the core crate.
Documentation: Enhances module and struct documentation across various files (lib.rs, builder.rs, tracer.rs, probe.rs, error.rs, config.rs) to include more detailed examples, descriptions of functionality, and usage guidelines. This includes clarifying the purpose and usage of key structs like Builder, Tracer, and Probe, as well as explaining configuration options and tracing strategies.
Builder Pattern Refinement: Refactors the Builder struct in builder.rs to follow best practices for builder patterns more closely. This includes method chaining and better method documentation.
Error Handling: Updates error handling in error.rs to provide more specific error messages and categorizes errors more clearly for better debugging and error tracking.
Configuration Enums: Enhances readability and usability of configuration-related enums in config.rs by adding display implementations and more descriptive comments.
Test Suite: Introduces a new test module in tests/ directory with initial tests focusing on the Builder functionality. This lays the groundwork for further unit and integration tests to cover new or changed functionality in the public API.
Updates documentation and adds tests to improve the public API of the core crate.
lib.rs,builder.rs,tracer.rs,probe.rs,error.rs,config.rs) to include more detailed examples, descriptions of functionality, and usage guidelines. This includes clarifying the purpose and usage of key structs likeBuilder,Tracer, andProbe, as well as explaining configuration options and tracing strategies.Builderstruct inbuilder.rsto follow best practices for builder patterns more closely. This includes method chaining and better method documentation.error.rsto provide more specific error messages and categorizes errors more clearly for better debugging and error tracking.config.rsby adding display implementations and more descriptive comments.tests/directory with initial tests focusing on theBuilderfunctionality. This lays the groundwork for further unit and integration tests to cover new or changed functionality in the public API.For more details, open the Copilot Workspace session.