DOI-USGS / DOI-USGS/dataretrieval-python
Use adapter terminology for configuration scope
- Vorherrschende Sprache
- Python
- Sterne
- 265
- Forks
- 63
- Ø Merge
- 1 T. 20 Std.
- Gemergte PRs (30 T.)
- 19
Beschreibung
## 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.
Beitragsleitfaden
Rechercherichtung
Start by searching configuration prose, comments, and caller-facing guidance for uses of “service,” then identify the wording-sensitive tests and documentation files involved. Audit facade, leaf, and configuration-profile usage without changing identifiers or behavior; run the documentation checks, wording-sensitive tests, offline suite, lint, and architecture checks, and confirm the invalid-configuration remedy is actionable.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Aktiv
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 48/100