Skip to content

policies/__init__.py points docs at tokenops-lld/policies/, which does not exist #68

Closed

Description

@tishachawla-jg

src/tokenops/control/policies/__init__.py line 6 says:

Governance docs (the action each policy takes) live in tokenops-lld/policies/.

There is no tokenops-lld/ directory in this repo. The docs are at docs/policies/, one page per policy. Anyone opening the package to find out what a policy does follows a dead path.

$ ls -d tokenops-lld
ls: cannot access 'tokenops-lld': No such file or directory

$ grep -rn "tokenops-lld" --include='*.py' --include='*.md' .
./src/tokenops/control/policies/__init__.py:6

One reference, one line. Point it at docs/policies/.

While you are there, __init__.py imports and exports ten policies but the directory holds eleven: trajectory_hint is absent from both the import block and __all__. It is real and reachable, just special-cased in src/tokenops/control/config.py because it needs a Store. A one-line note in the docstring saying so would stop the next reader assuming it is dead code. Do not try to add it to __all__; that is a separate design question.

Verify

make lint
make test

Done when

  • The docstring points at docs/policies/.
  • The trajectory_hint exception is mentioned rather than silently omitted.

Genuinely a two-line change. Good if you want a first PR to get the workflow out of the way before taking something larger like #66.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions