Back to all reviewers

Technical precision matters

hashicorp/terraform
Based on 3 comments
Other

When documenting algorithms, data structures, and computational processes, use precise and objective language rather than subjective assessments. Replace phrases like "better approach" with specific technical comparisons that highlight concrete differences, such as:

Algorithms Other

Reviewer Prompt

When documenting algorithms, data structures, and computational processes, use precise and objective language rather than subjective assessments. Replace phrases like “better approach” with specific technical comparisons that highlight concrete differences, such as:

// Instead of this:
// This sorting algorithm is better than bubble sort.

// Write this:
// This merge sort implementation has O(n log n) time complexity compared 
// to bubble sort's O(n²), making it more efficient for large datasets.

When providing examples of operations or syntax, maintain consistent formatting and avoid abbreviations for clarity. This precision enables team members to make informed decisions about algorithmic trade-offs and performance characteristics without ambiguity.

3
Comments Analyzed
Other
Primary Language
Algorithms
Category

Source Discussions