Verb forms in reference documentationStay organized with collectionsSave and categorize content based on your preferences.
When you're writing reference documentation for a method, phrase the main
method description in terms of what the method does (gets,lists,creates,searches), rather than what the developer would use it to do (get,list,create,search).
It's a subtle distinction that manifests mostly in whether the initial verb
in the description has an-sat the end or not.
Recommended: tasks.insert: Creates a new
task on the specified task list.
Not recommended: tasks.insert: Create a
new task on the specified task list.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-15 UTC."],[],["Method descriptions in reference documentation should focus on the method's actions, using verbs with an \"-s\" ending. This means describing what the method *does* (e.g., *creates*, *lists*) rather than what the developer *would do* with it (e.g., *create*, *list*). For example, \"Creates a new task\" is preferred over \"Create a new task.\" This convention enhances clarity and consistency in API documentation. Refer to the Google Cloud API design guide for further details.\n"]]
