Some of the documentation was missing because of the way the code was arranged. This PR refactors the code to ensure that the documentation is as clean as possible.
CiMessage Trait
The was implemented using an internal trait CIMessageDetail train and then implementing a blanked trait for all classes which implement the detail trait. Unfortunately this blanket impl was not picked up by the docs tool. Instead of using the blanket impl, we simply use a macro for the CIMessage trait now. It's not ideal, but it works.
CI Message
Brings ci messages out of internal modules so that they are less deep in the crate namespace.
Builder types renaming
All builder types are names *MessageBuilder instead of just *Builder.
BenLeadbetter
commented
1 year ago
Documentation Cleanup
Some of the documentation was missing because of the way the code was arranged. This PR refactors the code to ensure that the documentation is as clean as possible.
CiMessage Trait
The was implemented using an internal trait
CIMessageDetailtrain and then implementing a blanked trait for all classes which implement the detail trait. Unfortunately this blanket impl was not picked up by the docs tool. Instead of using the blanket impl, we simply use a macro for theCIMessagetrait now. It's not ideal, but it works.CI Message
Brings ci messages out of internal modules so that they are less deep in the crate namespace.
Builder types renaming
All builder types are names
*MessageBuilderinstead of just*Builder.