Skip to content

AIP-192 has contradictory guidance about comment style #1631

Description

@ekuefler

https://google.aip.dev/192#style says this:

Comments should be in grammatically correct American English. However, the first sentence of each comment should omit the subject and be in the third-person present tense

The part about third-person present tense is clearly meant to apply specifically to service methods, not e.g. to fields. All other examples in other specs use full noun phrases for field documentation and do not omit the subject. But nothing in this section scopes the guidance, so read literally it sounds like all comments should omit subjects.

This is causing practical issues for AI review tools inside of Google that are applying this statement over-eagerly.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions