Skip to content

RFCs 505 and 1574 contain contradictory information about method documentation #3784

@vigna

Description

@vigna

In both RFCs, you can find the following phrase:

The summary line should be written in third person singular present indicative form. Basically, this means write "Returns" instead of "Return".

However, the only example given in the two RFCs is

// Wait for the main task to return, and set the process error code
// appropriately.

Personally I prefer third person. The examples should be amended.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions