code-documentation

Standardize Pact 5 documentation by enforcing @doc annotations on all public defun, defcap, and defschema definitions. This ensures consistent inline documentation by requiring parameter descriptions and specific formatting rules within each module block.

@doc annotations in Pact 5 schemas require descriptive text for schema fields and parameter details. The documentation standard also mandates using backslash line continuations for long lines to maintain readability and consistent code structure.

Yes, Pact 5 documentation standards require parameter descriptions within @doc blocks. Enforcing these details for defun, defcap, and defschema definitions ensures code quality during reviews and improves onboarding for new contributors.

Format long lines in Pact 5 module code documentation by using backslash line continuations. This formatting rule is enforced alongside @doc block requirements to maintain standardized, discoverable inline documentation across functions and schemas.

Add @doc blocks to Pact 5 capabilities and schemas during module development and review workflows. You must include them whenever defining public defcap and defschema structures to ensure all parameter details and guards are properly documented.