Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

'pin rm' helptext: rewrite description as object is not removed from local storage (immediately) #8947

Merged
merged 1 commit into from
May 6, 2022

Conversation

RubenKelevra
Copy link
Contributor

No description provided.

Copy link
Contributor

@schomatis schomatis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, our pin docs are confusing. I'd prefer no to talk about a pin list (just the pin of the object itself) but this is a step in the right direction.

@schomatis schomatis merged commit 831c339 into ipfs:master May 6, 2022
@RubenKelevra
Copy link
Contributor Author

@schomatis wrote:

I'd prefer no to talk about a pin list (just the pin of the object itself) but this is a step in the right direction.

In this case it makes sense, as a pin list is mentioned on the same page:

ipfs pin ls []... - List objects pinned to local storage.

@RubenKelevra RubenKelevra deleted the patch-7 branch May 6, 2022 15:38
@schomatis
Copy link
Contributor

(Very subtle, opinionated, and unimportant, but since you mention it:)

List objects pinned to local storage.

The list verb here merely says it's crafting a list for the user to inspect what we have pinned.

A pin list as a noun implies a representation of our internal state of those pins, not what we show to the user but what we have inside that the user is removing from. That's why I prefer to focus on the single pin attached to the object of interest without implying anything about the rest of the pins (or how or where they are stored).

guseggert pushed a commit that referenced this pull request Jun 8, 2022
'pin rm' helptext: rewrite description as object is not removed from local storage (immediately)
guseggert pushed a commit that referenced this pull request Jun 8, 2022
'pin rm' helptext: rewrite description as object is not removed from local storage (immediately)

(cherry picked from commit 831c339)
guseggert pushed a commit that referenced this pull request Jun 8, 2022
'pin rm' helptext: rewrite description as object is not removed from local storage (immediately)

(cherry picked from commit 831c339)
guseggert pushed a commit that referenced this pull request Jun 8, 2022
'pin rm' helptext: rewrite description as object is not removed from local storage (immediately)

(cherry picked from commit 831c339)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants