`Diagnostic` and `Diagnostics` are very similar names

apollographql / apollo-rs

Spec compliant GraphQL Tools in Rust.

Apache License 2.0

566 stars 45 forks source link

`Diagnostic` and `Diagnostics` are very similar names #711

Closed SimonSapin closed 10 months ago

SimonSapin commented 11 months ago

This is breaking change that we should either make before 1.0 leaves beta, or decide not to make.

apollo-compiler 1.0.0-beta.4 exports two types named Diagnostics (plural) and Diagnostic (singular). The former is a collection of any number of the latter, and has a corresponding .iter() method. This is all self-consistent, but because the two names are so close it’s easy to confuse one for the other.

Should one or both of them be renamed to avoid this confusion? To what?

SimonSapin commented 10 months ago

From today’s discussion:

The same pattern exists with Directive v.s. Directives
A List suffix may be a way to fix this: DiagnosticList contains Vec<Diagnostic>, and DirectiveList contains Vec<Directive>