Maintain consistency in wording, formatting, and specificity across all documentation strings to improve readability and translation quality. Key practices:
Maintain consistency in wording, formatting, and specificity across all documentation strings to improve readability and translation quality.
Key practices:
Example of consistent template description:
{
"fan_mode_command_template": "A [template](https://example.com) to compose the payload to be published at the fan mode command topic.",
"power_command_template": "A [template](https://example.com) to compose the payload to be published at the power command topic."
}
This ensures documentation is professional, clear, and maintainable across the entire codebase while supporting internationalization efforts.
Enter the URL of a public GitHub repository