Skip to content
This repository has been archived by the owner on Feb 27, 2023. It is now read-only.

[feature]: add generate doc cmd for supernode #1100

Merged
merged 1 commit into from
Nov 28, 2019

Conversation

starnop
Copy link
Contributor

@starnop starnop commented Nov 27, 2019

Signed-off-by: Starnop starnopg@gmail.com

Ⅰ. Describe what this PR did

Ⅱ. Does this pull request fix one issue?

fixes #1097

Ⅲ. Why don't you add test cases (unit test/integration test)? (你真的觉得不需要加测试吗?)

Ⅳ. Describe how to verify it

Ⅴ. Special notes for reviews

@codecov-io
Copy link

codecov-io commented Nov 27, 2019

Codecov Report

Merging #1100 into master will decrease coverage by 0.02%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1100      +/-   ##
==========================================
- Coverage   47.28%   47.25%   -0.03%     
==========================================
  Files         118      116       -2     
  Lines        7244     7203      -41     
==========================================
- Hits         3425     3404      -21     
+ Misses       3549     3532      -17     
+ Partials      270      267       -3
Impacted Files Coverage Δ
cmd/supernode/app/root.go 69.35% <100%> (+0.16%) ⬆️
cmd/dfdaemon/app/root.go 67.41% <100%> (+0.37%) ⬆️
cmd/dfget/app/root.go 71.6% <100%> (+0.17%) ⬆️
supernode/daemon/mgr/scheduler/manager.go 23.28% <0%> (+1.36%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 72b98ba...c7ae59b. Read the comment docs.

@@ -36,7 +36,7 @@ func init() {
genDocCommand := &GenDocCommand{}
genDocCommand.cmd = &cobra.Command{
Use: "gen-doc",
Short: "Generate Document for dfget command line tool with MarkDown format",
Short: "Generate Document for supernode command line tool with MarkDown format",
Copy link
Member

Choose a reason for hiding this comment

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

with MarkDown format I think with isn't appropriate,in can be better?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agree

genDocCommand := &GenDocCommand{}
genDocCommand.cmd = &cobra.Command{
Use: "gen-doc",
Short: "Generate Document for dfdaemon command line tool with MarkDown format",
Short: fmt.Sprintf("Generate Document for %s command line tool with MarkDown format", name),
Copy link
Member

Choose a reason for hiding this comment

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

ditto

Copy link
Collaborator

@yeya24 yeya24 left a comment

Choose a reason for hiding this comment

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

LGTM

Signed-off-by: Starnop <starnopg@gmail.com>
@fengzixu
Copy link
Collaborator

LGTM

@yeya24 yeya24 merged commit f8ecf02 into dragonflyoss:master Nov 28, 2019
inoc603 pushed a commit to inoc603/Dragonfly that referenced this pull request Dec 23, 2019
[feature]: add generate doc cmd for supernode
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[CI] generating supernode cli doc with robot
6 participants