Skip to content

[documentation] MATLAB binding README references ceam.pyx as a legacy artifact, but it was deleted in the same commit that added the reference #22

Description

@djkees

Summary
source/bind/matlab/README.md:23,29 both mention source/bind/matlab/ceam.pyx (:23: "it does not build a separate supported ceam extension"; :29, the "Legacy note": "ceam.pyx is an old experimental artifact and is not the supported interface path"). The file doesn't exist anywhere in the current tree, and its only git history is: added in "Initial public release," then deleted in commit f8210c9.

Reproduction
git show --stat f8210c9 (nasa#79, "Feat/matlab"): that same commit's diff shows source/bind/matlab/ceam.pyx | 135 ----- (full deletion) and rewrites README.md, adding the exact "Legacy note" paragraph that still points at the now-deleted file — so this wasn't documentation that drifted stale over time, it was already a dangling reference the moment it was written.

Expected behavior
The README doesn't reference a file that has never existed alongside it.

Actual behavior
Two lines describe ceam.pyx as a legacy artifact to be aware of, even though it isn't present in the repository at any commit where the README containing that description also exists.

Additional context
Grepped all .md/.rst files repo-wide for "ceam" — only these two lines reference it. Suggested direction: drop the "Legacy note" section (the surrounding paragraphs already fully explain the supported Python-based path, so it isn't load-bearing) or reword it to describe the historical fact without implying the file still exists. Trivial, docs-only fix. Idea from the 2026-08-29 codebase sweep.


Drafted with Claude's assistance

  • The dangling reference and its origin commit were confirmed via git log/git show --stat directly, in the 2026-08-29 codebase sweep that originated this item.
  • Checked gh issue list on both nasa/cea and djkees/cea before filing to confirm this isn't a duplicate.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationpriority: lowCosmetic, nice-to-have, or open-ended with no clear action yetstatus: pr-draftedA PR (draft or open) exists addressing this issue

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions