ipfs/kubo

`ipfs object patch rm-link` help description is vague

Open

#2,474 opened on Mar 15, 2016

View on GitHub
 (2 comments) (2 reactions) (0 assignees)Go (13,906 stars) (2,725 forks)batch import
help wantedkind/supporttopic/docs-ipfs

Description

🐕  ipfs object patch rm-link --help

    ipfs object patch rm-link <root> <link> - Remove a link from an object.

ARGUMENTS:

    <root> - The hash of the node to modify.
    <link> - Name of the link to remove.

DESCRIPTION:

    Removes a link by the given name from root.

I have no idea what that description means, and it seems to contradict 'Remove a link from an object'. Can someone explain what root is, and what this means?

Part of the https://github.com/ipfs/http-api-spec/pull/32 effort.

Contributor guide

Tech stack
go
Domain
clidocumentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic understanding of IPFS objects
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Review the current help text for `ipfs object patch rm link` in the Kubo codebase (likely in core/commands/object/patch.go). The issue references a related PR at https://github.com/ipfs/http api spec/pull/32 that may provide context. Compare with similar commands' help descriptions for consistency. Propose a clearer explanation of what 'root' and 'link' refer to in the context of IPFS objects.