Skip to content

Make decommutator helper functions private - #66

Merged
namurphy merged 1 commit into
PlasmaPy:mainfrom
namurphy:underscores
Oct 6, 2026
Merged

namurphy merged 1 commit into
PlasmaPy:mainfrom
namurphy:underscores

Conversation

@namurphy

@namurphy namurphy commented Oct 6, 2026

Copy link
Copy Markdown
Member

Prefixes the helper functions in src/pyfaradaycup/decommutator/ with an underscore to mark them as private, and removes them from each module's __all__.

These functions remain public:

  • main.pfc_decommutator: the command line tool
  • swp_spc_l02l1.main: converts one L0 file into L1 CDF files
  • ccsds_reader_pipeline.read_file and read_file_sc: read an L0 file into Python data structures

The apid_obj class is unchanged.

Now private:

  • ccsds_reader_pipeline: _read_stdin, _file2bytestr, _choose_file, _wrapper_status, _read_bytestr, _parse_ccsds_head, _parse_pkt, _get_layout, _get_layout_sc
  • swp_spc_l02l1: _cdf35e_35f, _cdf351_353_354, _cdf352, _secsubsec2scet, _statusmsg, _get_newest_kernel, _get_newest_skeleton

Call sites, docstrings, and the decommutator README.md are updated to use the new names.

🤖 Generated with Claude Code

Prefix helper functions in the decommutator with an underscore and
remove them from __all__. The functions that remain public are
pfc_decommutator, swp_spc_l02l1.main, and the L0 file readers
read_file and read_file_sc.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@namurphy
namurphy merged commit a3002f1 into PlasmaPy:main Oct 6, 2026
15 checks passed
@namurphy
namurphy deleted the underscores branch October 6, 2026 23:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant