Ensure documentation uses precise, accurate language that clearly describes functionality and highlights important behaviors users need to understand. Avoid vague or misleading terms that could confuse users about what the code actually does.
Ensure documentation uses precise, accurate language that clearly describes functionality and highlights important behaviors users need to understand. Avoid vague or misleading terms that could confuse users about what the code actually does.
Key practices:
Example improvement:
// Instead of:
"This extension allows you to convert multiple files..."
// Use:
"This example shows how to convert multiple files..."
// And add clarifying details:
"Note that original files will remain unchanged and new markdown files are created with the same base name."
This ensures users have accurate expectations about functionality and understand important implementation details that affect their workflow.
Enter the URL of a public GitHub repository