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

Add helptext, default logic to ipfs stats #2681

Merged
merged 1 commit into from
May 16, 2016

Conversation

RichardLitt
Copy link
Member

I've added: Synopsis, shortDescription, and longDescription for stats and stats bw.
I also added default(false) for poll and default("1s") for interval, and modified the logic to make it fit.

Part of #2484 and #2647.

License: MIT
Signed-off-by: Richard Littauer [email protected]

@RichardLitt RichardLitt added the topic/docs-ipfs Topic docs-ipfs label May 12, 2016
@Kubuxu
Copy link
Member

Kubuxu commented May 12, 2016

LGMT

IIRC ipfs stats bw was quite broken some time ago, I don't know if it got fixed but it is out of the scope in this case.

Teamcity fail seems to be unrelated.

@RichardLitt RichardLitt force-pushed the feature/spruce-upstat branch from fbba4d6 to 14023a0 Compare May 12, 2016 17:49
@RichardLitt
Copy link
Member Author

Updated synopsis to match man git.

Yeah, ipfs stats seems pretty neglected.

@RichardLitt RichardLitt force-pushed the feature/spruce-upstat branch from 14023a0 to 6245903 Compare May 12, 2016 17:59
@RichardLitt
Copy link
Member Author

Fixed spacing.

@Kubuxu
Copy link
Member

Kubuxu commented May 13, 2016

LGTM but you have binary files in your PR.

@RichardLitt RichardLitt force-pushed the feature/spruce-upstat branch from 6245903 to 56fcb10 Compare May 13, 2016 21:53
@RichardLitt
Copy link
Member Author

Fixed.

@Kubuxu Kubuxu added the RFM label May 13, 2016
Tagline: "Query ipfs statistics.",
Synopsis: "ipfs stats <command>",
ShortDescription: `'ipfs stats' is a set of commands to help look at statistics for your ipfs node.`,
LongDescription: `'ipfs stats' is a set of commands to help look at statistics for your ipfs node.`,
Copy link
Member

Choose a reason for hiding this comment

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

I think we can probably add some logic that sets the long description to the short description if unset

Copy link
Member

Choose a reason for hiding this comment

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

(not that you have to change anything here, just saying that might be a nice feature)

Copy link
Member Author

Choose a reason for hiding this comment

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

Opened #2691.

@whyrusleeping whyrusleeping added need/author-input Needs input from the original author and removed RFM labels May 13, 2016
@RichardLitt RichardLitt force-pushed the feature/spruce-upstat branch 2 times, most recently from b920e36 to 1523ae3 Compare May 14, 2016 00:43
@RichardLitt RichardLitt removed the need/author-input Needs input from the original author label May 14, 2016
@Kubuxu
Copy link
Member

Kubuxu commented May 15, 2016

LGTM

@Kubuxu Kubuxu added the RFM label May 15, 2016
return
}
interval = v
v, err := time.ParseDuration(timeS)
Copy link
Member

Choose a reason for hiding this comment

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

interval, err := ...

@whyrusleeping whyrusleeping added need/author-input Needs input from the original author and removed RFM labels May 15, 2016
I've added: Synopsis, shortDescription, and longDescription for stats and stats bw.
I also added default(false) for poll and default("1s") for interval, and modified the logic to make it fit.

Part of #2484 and #2647.

License: MIT
Signed-off-by: Richard Littauer <[email protected]>
@RichardLitt RichardLitt force-pushed the feature/spruce-upstat branch from 1523ae3 to 8ee399f Compare May 16, 2016 14:59
@RichardLitt RichardLitt added need/review Needs a review and removed need/author-input Needs input from the original author labels May 16, 2016
@whyrusleeping whyrusleeping merged commit b0b1e0f into master May 16, 2016
@whyrusleeping whyrusleeping deleted the feature/spruce-upstat branch May 16, 2016 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
need/review Needs a review topic/docs-ipfs Topic docs-ipfs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants