DOI-USGS / DOI-USGS/dataretrieval-python
Use adapter terminology for configuration scope
- Lenguaje dominante
- Python
- Estrellas
- 265
- Forks
- 63
- Merge medio
- 1 d 20 h
- PR fusionados (30 d)
- 19
Descripción
## Parent
#406
## What to build
Correct configuration prose, comments, and caller-facing guidance that describe a setting or default as scoped to a service when the package's configuration scope is the adapter. Preserve uses of "service" that genuinely name an external system, host behavior, upstream capacity, or service-neutral machinery.
The caller-facing invalid-configuration remedy must name real configuration objects and remain literally actionable. This is a wording correction only: do not rename identifiers, configuration classes, settings, adapter keys, or public parameters.
## Acceptance criteria
- [ ] Every configuration use of "service" names an external system rather than the scope of a setting, default, profile, or override.
- [ ] Every tuning-scope explanation consistently says adapter or names the adapter's configuration.
- [ ] The invalid-configuration remedy names valid package-wide and adapter-specific configuration objects, and following it produces a working call.
- [ ] Legitimate external-service, gateway, host, and service-neutral wording is unchanged.
- [ ] No public identifier, parameter, class, setting, configuration grammar, or behavior changes.
- [ ] The change description records that facade, leaf, and configuration-profile usage were audited and found compliant rather than mechanically rewritten.
- [ ] Documentation, wording-sensitive tests, the offline suite, lint, and architecture checks pass.
## Blocked by
None — can start immediately.
Guía de contribución
Línea de trabajo
Empieza buscando usos de “service” en la prosa de configuración, los comentarios y las indicaciones dirigidas a quienes realizan llamadas; después, identifica las pruebas sensibles a la redacción y los archivos de documentación implicados. Audita el uso de facade, leaf y configuration-profile sin cambiar identificadores ni comportamiento; ejecuta las comprobaciones de documentación, las pruebas sensibles a la redacción, la suite offline, lint y las comprobaciones de arquitectura, y confirma que el remedio para una configuración no válida es aplicable.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Activo
- Claridad
- Bastante claro
- Aptitud para principiantes
- 48/100