Skip to content

Zookeeper 3604 Added documentation for Path variable#1264

Closed
asutosh936 wants to merge 2 commits intoapache:masterfrom
asutosh936:ZOOKEEPER-3604
Closed

Zookeeper 3604 Added documentation for Path variable#1264
asutosh936 wants to merge 2 commits intoapache:masterfrom
asutosh936:ZOOKEEPER-3604

Conversation

@asutosh936
Copy link
Copy Markdown
Contributor

No description provided.

@maoling
Copy link
Copy Markdown
Member

maoling commented Mar 2, 2020

@eolivelli Do you want to merge it: ) ?

Copy link
Copy Markdown
Contributor

@eolivelli eolivelli left a comment

Choose a reason for hiding this comment

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

I am sorry.
This patch is not worth a commit.

I appreciate the intent but it would be better to create a bigger path, for instance a patch that fixes all of this cases (empty parameters description javadoc in the whole file)

@asutosh936
Copy link
Copy Markdown
Contributor Author

@eolivelli - Make sense, will update PR with rest of the missing path description for given file.

@asutosh936
Copy link
Copy Markdown
Contributor Author

@eolivelli - Have updated documentation for all path and watch variables. Please review.

@asutosh936
Copy link
Copy Markdown
Contributor Author

Team, any update on this PR?

@asutosh936
Copy link
Copy Markdown
Contributor Author

@eolivelli - Could You please review and merge this PR?

Copy link
Copy Markdown
Contributor

@eolivelli eolivelli left a comment

Choose a reason for hiding this comment

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

Hi.

I feel this patch still is not worth to be committed.
If we want to fix javadoc we should do it in a consistent way and have a plan.

What real value is added by this patch?

I am sorry I don't want to be annoying and I appreciate your efforts

It would be better to start a plan to fix javadoc and make them required someway.
This is not trivial because it is difficult to draw a line and decide what is important and what is boilerplate.

Maybe I am wrong.
This patch is open, if any other commiter wants to sponsor it I am not against it.

I am +0

@asutosh936 asutosh936 closed this Jul 19, 2020
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.

3 participants