DOI-USGS / DOI-USGS/dataretrieval-python

Use adapter terminology for configuration scope

Open
#407 0 comments 0 reactions 0 assignees View on GitHub
ready-for-agent
Dominant language
Python
Stars
265
Forks
63
Avg merge
1d 20h
Merged PRs (30d)
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.

Contributor guide

Open the contributing guide

Research direction

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.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.