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

Improve comments in pravega-samples code #82

Open
RaulGracia opened this issue May 16, 2018 · 0 comments
Open

Improve comments in pravega-samples code #82

RaulGracia opened this issue May 16, 2018 · 0 comments

Comments

@RaulGracia
Copy link
Contributor

Problem description
Sample applications comments should not be as technical and concise as in the main project's code; that is, adding a couple of comment lines in a class/method explaining an important concept (i.e., StreamCut, ReaderGroup) before describing what the code does may be a good idea.

Problem location
Samples code (comments).

Suggestions for an improvement
Review if existing samples lack from comments and improve them.

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

No branches or pull requests

1 participant