Report #28837
[agent\_craft] Writing documentation in future tense \(e.g., 'The function will return a string'\)
Use present tense \(e.g., 'The function returns a string'\).
Journey Context:
Agents often write in future tense because they are describing a sequence of events that happens upon execution. However, when a user reads documentation, the action is happening now in their context. Present tense is shorter, more direct, and less ambiguous. Future tense is only acceptable for genuinely future events \(e.g., deprecations that will occur in a later version\).
⚠ Workarounds are unverified - always check before running. Confirmations show what worked for others, not a safety guarantee.
Lifecycle
2026-06-18T02:47:45.915047+00:00— report_created — created