DOI-USGS / DOI-USGS/dataretrieval-python
Use adapter terminology for configuration scope
- Langage dominant
- Python
- Étoiles
- 265
- Forks
- 63
- Merge moyen
- 1 j 20 h
- PR mergées (30 j)
- 19
Description
## 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.
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
Commencez par rechercher les occurrences de « service » dans la prose de configuration, les commentaires et les consignes destinées aux appelants, puis identifiez les tests sensibles à la formulation et les fichiers de documentation concernés. Auditez l’utilisation de facade, leaf et configuration-profile sans modifier les identifiants ni le comportement ; exécutez les vérifications de documentation, les tests sensibles à la formulation, la suite hors ligne, lint et les vérifications d’architecture, et confirmez que le remède à une configuration invalide est exploitable.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- Active
- Clarté
- Plutôt claire
- Accessibilité débutants
- 48/100