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.

Sign up for GitHub

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

Jump to bottom

Write inline documentation for src/protobuf/index.js #131

Open
tcp opened this issue May 27, 2020 · 0 comments
Open

Write inline documentation for src/protobuf/index.js #131

tcp opened this issue May 27, 2020 · 0 comments
Labels
Good first issue 🎓 Perfect for beginners, welcome to OpenMined! Priority: 3 - Medium 😒 Should be fixed soon, but there may be other pressing matters that come first Severity: 4 - Low 😎 An aesthetic issue or is the result of non-conformance to a standard Type: Documentation 📚 Improvements or additions in documentation for some file, feature, or codebase
Milestone
0.3.0

Comments

@tcp
Copy link

tcp commented May 27, 2020

Where?

src/protobuf/index.js

Who?

Any developer who wants to work on syft.js should be able to read inline documentation for this file, as well as any file in the project.

What?

We need to go "line-by-line" and create inline documentation for this file. Please try to use proper punctuation and English grammar to the best of your ability.

Additional Context

None
@tcp tcp added Good first issue 🎓 Perfect for beginners, welcome to OpenMined! Priority: 3 - Medium 😒 Should be fixed soon, but there may be other pressing matters that come first Severity: 4 - Low 😎 An aesthetic issue or is the result of non-conformance to a standard Type: Documentation 📚 Improvements or additions in documentation for some file, feature, or codebase labels May 27, 2020
@cereallarceny cereallarceny added this to the 0.2.0 milestone Jul 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Good first issue 🎓 Perfect for beginners, welcome to OpenMined! Priority: 3 - Medium 😒 Should be fixed soon, but there may be other pressing matters that come first Severity: 4 - Low 😎 An aesthetic issue or is the result of non-conformance to a standard Type: Documentation 📚 Improvements or additions in documentation for some file, feature, or codebase
Projects
None yet
Milestone
0.3.0
Development

No branches or pull requests
2 participants
@tcp @cereallarceny