DOI-USGS / DOI-USGS/dataretrieval-python

Use adapter terminology for configuration scope

Aperta
#407 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
ready-for-agent
Lingua principale
Python
Stelle
265
Fork
63
Merge medio
1g 20h
PR unite (30g)
19

Descrizione

## 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.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Attiva
Chiarezza
Abbastanza chiara
Idoneità per principianti
48/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.