gchq / gchq/sleeper

Improve documentation of table ID

Open
#6,281 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Java
Stars
107
Forks
29
Avg merge
19h 46m
Merged PRs (30d)
141

Description

We can make it clear that the table ID is not editable, and if you changed it the system would attempt to create a new table. That would fail because there's already a table with the same name.

Contributor guide

Open the contributing guide

Research direction

Locate the existing documentation for table IDs and read how editability is currently described. Clarify that the table ID cannot be edited, and explain that changing it would attempt to create a new table with the same name and fail because that table already exists.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.