Skip to content

EPICS: drop or honestly re-document the docs.py shim #367

@gilesknap

Description

@gilesknap

Follow-up from review of fc8e710 (#358 / PR #360).

src/fastcs/transports/epics/docs.py claims to keep "backwards-compatible imports", but neither symbol it re-exports was previously importable from this path:

  • emit_docs_files is brand-new in emission.py.
  • EpicsDocsOptions was moved to options.py, and epics/__init__.py was retargeted to from .options import EpicsDocsOptions.

The prior public API of this module was the EpicsDocs class, which has been removed. Nothing in-tree imports from fastcs.transports.epics.docs anymore.

Options

  • Delete the module (and docs/_api/fastcs.transports.epics.docs.rst). Likely the right call — it's pure dead weight.
  • Or keep it and fix the docstring to say "thin compatibility re-export for downstream code that imported the old class path", with a deprecation note.

Refs

  • src/fastcs/transports/epics/docs.py:1-12
  • src/fastcs/transports/epics/__init__.py (already imports EpicsDocsOptions from .options)
  • docs/_api/fastcs.transports.epics.docs.rst (Sphinx page would also need to go if the module goes)

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions