Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

chore(cli): sweep stale comments, misleading messages, and a tracing stop gap

Open
  • Is something wrong?
#340 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
cli

Research direction

Read the four cited CLI files and raven/cli/_exit.py first, then inspect the related pytest hooks and tracing lifecycle tests. Verify the current shutdown comments, doctor wording, onboard backend selection, and tracing viewer adoption path. Done means the comments and messages describe current behavior, and tracing stop has an explicit, tested outcome for an unrecorded viewer.

Written by the indexing model from the issue text.

Description

Problem

Four small pieces of drift left behind by recent CLI refactors: stale comments, two misleading messages/docstrings, and a tracing lifecycle gap. None is worth its own PR; together they make one clean sweep.

Evidence

  1. Stale hard-exit comments. raven/cli/agent_commands.py:404 still says "The exit chokepoint in raven.cli.commands.run hard-exits past finalization when that hazard is live", and raven/cli/agent_commands.py:356 refers to "the hard-exit below", but raven/cli/_exit.py's own docstring states that gate is gone ("That gate is gone: nothing under raven/ imports lancedb") and the only remaining caller is the pytest session hook. Related tests still monkeypatch os._exit as a leftover safety net for that path; harmless, but it documents a mechanism that no longer exists there.
  2. Doctor's exit-code docstring omits the invalid-config state. raven/cli/doctor_commands.py:7 lists exit 1 as "static check failed (config missing / schema invalid / unresolved routing)"; the invalid-JSON config state (Config line shows a warning instead of a green check, exit 1) is only implied.
  3. Onboard's sandbox skip message can be wrong. raven/cli/onboard_commands.py:2056 prints "Keeping run location: host (direct)." on the skip/non-interactive path even when the persisted sandbox backend is boxlite, i.e. it asserts a state that is not the one being kept.
  4. An externally started tracing viewer cannot be stopped. raven/cli/tracing_commands.py:200 reuses a live-and-healthy viewer on the expected port even when there is no pid record (e.g. started by an older raven or by hand), so raven tracing stop cannot manage that instance.

Suggested direction

One small cleanup PR: rewrite the two comments to describe the current shutdown behavior (and drop the residual os._exit monkeypatches if nothing needs them), add the invalid-config wording to the doctor docstring, make the onboard skip message read the persisted backend before claiming what is kept, and for the tracing viewer either discover the pid when adopting an unrecorded instance (lsof/psutil) or print that stop will not manage it.

Dominant language
Python
Stars
4.1k
Forks
94
Avg merge
10h 2m
Merged PRs (30d)
376

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from EverMind-AI/Raven

All issues in EverMind-AI/Raven

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.