Skip to content

API docs: remove trailing periods from operation summaries#9636

Merged
ahl merged 4 commits intomainfrom
openapi-summaries
Jan 14, 2026
Merged

API docs: remove trailing periods from operation summaries#9636
ahl merged 4 commits intomainfrom
openapi-summaries

Conversation

@ahl
Copy link
Copy Markdown
Contributor

@ahl ahl commented Jan 13, 2026

No description provided.

) -> Result<HttpResponseOk<ResultsPage<views::IpPoolRange>>, HttpError>;

/// Add range to IP pool.
/// Add range to an IP pool
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We try to avoid articles too, if possible.

Image

Comment thread nexus/external-api/src/lib.rs Outdated
}

/// List members of a multicast group.
/// List members of a multicast group
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd remove the "a" in all of these.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok; I tried to make the file more consistent. BE IT ON YOUR HEAD

@ahl ahl marked this pull request as ready for review January 14, 2026 00:10
@ahl ahl merged commit c197cca into main Jan 14, 2026
17 checks passed
@ahl ahl deleted the openapi-summaries branch January 14, 2026 23:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants