CentreForDigitalHumanities / CentreForDigitalHumanities/Textcavator

Backend CLI: --mappings-only and --create-only confusing

Open
#1,781 0 comments 0 reactions 0 assignees View on GitHub
backend code quality
Dominant language
Python
Stars
12
Forks
3
Avg merge
3d 3m
Merged PRs (30d)
9

Description

The [`index` command](https://github.com/CentreForDigitalHumanities/I-analyzer/blob/develop/documentation/Indexing-corpora.md) includes these two flags (among others):

- `--mappings-only`: the index job should create an index but not populate it with documents
- `--create-only`: the index job should be created but not run

I didn't think of this when I worked on #1759, but `--create-only` sounds like it means "only create the index", i.e. what `--mappings-only` does.

This is not ideal; perhaps these flag should be renamed.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the index command and documentation/Indexing-corpora.md, where --mappings-only and --create-only are described. Compare the flags' actual behavior with their names, decide on unambiguous replacements, and update the command documentation so each option's meaning is clear.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend, cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.