# Update tenses of doc comment summary lines \(\#4161\) · gitcafe/zed

[View on GitCafe](https://git.cafe/gitcafe/zed/commit/01f06f96a15887703a06e5953c564005c308a9c9)

Repository: [gitcafe/zed](https://git.cafe/gitcafe/zed)

Visibility: public

Requested revision: 01f06f96a15887703a06e5953c564005c308a9c9

Requested commit: 01f06f96a15887703a06e5953c564005c308a9c9

Commit: 01f06f96a15887703a06e5953c564005c308a9c9

Tree: 4fef19eaedb7ca664a851449b4c70ba878bcfefd

Author: Marshall Bowers

Committer: GitHub

## Message

```
Update tenses of doc comment summary lines (#4161)

This PR updates the tenses used by the summary line of doc comments to
match the [Rust API documentation
conventions](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#summary-sentence).

Specifically:

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

I'm sure there are plenty occurrences that I missed.

Release Notes:

- N/A
```

## Parents

- [cb1b7915ee90582ee3ddf346596d65d2082874f3](https://git.cafe/gitcafe/zed/commit/cb1b7915ee90582ee3ddf346596d65d2082874f3?format=markdown)

[Source at this commit](https://git.cafe/gitcafe/zed/tree/01f06f96a15887703a06e5953c564005c308a9c9?format=markdown)