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

Write documentation for the user-facing functions #2

Open
tholop opened this issue Jan 7, 2021 · 2 comments
Open

Write documentation for the user-facing functions #2

tholop opened this issue Jan 7, 2021 · 2 comments
Assignees
Labels
Good first issue 🎓 Perfect for beginners, welcome to OpenMined! Type: Documentation 📚 Improvements or additions in documentation for some file, feature, or codebase

Comments

@tholop
Copy link
Member

tholop commented Jan 7, 2021

Where?

Things to document in priority:

Later:

  • The important Rust primitives

Who?

  • Anyone doing pip install sycret should be able to read the doc to use fss.py
  • The rest of the documentation will be useful for contributors and maintainers

What?

Let's use Google-style Python docstrings (OpenMined/SyMPC#28). It can be cool to plug a static documentation website builder into the workflow 😁

@tholop tholop added Good first issue 🎓 Perfect for beginners, welcome to OpenMined! Type: Documentation 📚 Improvements or additions in documentation for some file, feature, or codebase labels Jan 7, 2021
@nph4rd
Copy link
Member

nph4rd commented Jan 7, 2021

I'd like to take this one!

@nph4rd nph4rd self-assigned this Jan 7, 2021
@tholop
Copy link
Member Author

tholop commented Jan 7, 2021

Awesome, thanks! Feel free to leave some gaps or ping me if some parameters or functions are unclear.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good first issue 🎓 Perfect for beginners, welcome to OpenMined! Type: Documentation 📚 Improvements or additions in documentation for some file, feature, or codebase
Projects
None yet
Development

No branches or pull requests

2 participants