Documentation should be clear, accurate, and provide meaningful information to users. Avoid misleading descriptions, template text that doesn’t add value, and unclear explanations that leave users confused about functionality.
Key practices:
Example of unclear vs clear documentation:
// Unclear - misleading about actual behavior
/// Don't force rebuild the parser when `--grammar_path` is specified
// Clear - accurately describes the relationship
/// `--grammar_path` implies force rebuild
Documentation should help users understand not just what something does, but how and when to use it effectively.
Enter the URL of a public GitHub repository