apple / apple/foundationdb

The waitopen and waitconnected commands in fdbcli have no help text

Open
#6,157 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
16.7k
Forks
1.6k
Avg merge
1d 20h
Merged PRs (30d)
126

Description

The `waitopen`, `waitconnected`, `changefeed`, and `blobrange` commands in fdbcli can be accessed via the autocomplete mechanism. These commands don't seem to be documented in the help text, though. If these commands aren't intended to be hidden, then we should add documentation. If they are intended to be hidden, then we should consider making them so they can't be autocompleted.

Contributor guide

Open the contributing guide

Research direction

Start by locating the fdbcli command registration and the help-text or autocomplete handling for waitopen, waitconnected, changefeed, and blobrange. Determine whether these commands are intended to be public or hidden, then document them or prevent their autocomplete exposure accordingly. Verify both help output and autocomplete behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.