Use @discardableResult consistently on completion-handler methods

Abierto Apto para principiantes
#466 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 2 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
76/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
swift
Área
api

Línea de trabajo

Empieza por localizar OpenAIProtocol, ResponsesEndpointProtocol, OpenAI y ResponsesEndpoint; después, inspecciona sus métodos con completion handler que devuelven CancellableRequest. Añade @discardableResult de forma coherente a esos métodos y ejecuta swift package diagnose-api-breaking-changes; el comando no debería indicar cambios incompatibles en la API.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Completion-handler methods return a CancellableRequest, which callers often don't need. Whether discarding it produces an "unused result" warning currently depends on the method:

Protocol Methods returning CancellableRequest With @discardableResult
OpenAIProtocol 27 24 (missing: audioCreateSpeechStream, audioTranscriptionStream, audioTranscriptionsVerbose)
ResponsesEndpointProtocol 4 0
FilesEndpointProtocol (#401) 5 5

Add @discardableResult to every completion-handler method that returns a CancellableRequest, in the protocols and in the concrete implementations (OpenAI, ResponsesEndpoint). Callers that use the concrete types directly get the same behaviour that way.

Adding @discardableResult is source-compatible: it only removes a warning. Run swift package diagnose-api-breaking-changes to confirm it reports nothing.

Lenguaje dominante
Swift
Estrellas
2.9k
Forks
519
Merge medio
2 d 14 h
PR fusionados (30 d)
8

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de MacPaw/OpenAI

Todos los issues de MacPaw/OpenAI

Issues similares

Más issues de Swift

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.