-
-
Notifications
You must be signed in to change notification settings - Fork 9
Write documentation for the user-facing functions #2
Copy link
Copy link
Open
Labels
Good first issue 🎓Perfect for beginners, welcome to OpenMined!Perfect for beginners, welcome to OpenMined!Type: Documentation 📚Improvements or additions in documentation for some file, feature, or codebaseImprovements or additions in documentation for some file, feature, or codebase
Metadata
Metadata
Assignees
Labels
Good first issue 🎓Perfect for beginners, welcome to OpenMined!Perfect for beginners, welcome to OpenMined!Type: Documentation 📚Improvements or additions in documentation for some file, feature, or codebaseImprovements or additions in documentation for some file, feature, or codebase
Type
Fields
Give feedbackNo fields configured for issues without a type.
Where?
Things to document in priority:
Later:
Who?
pip install sycretshould be able to read the doc to usefss.pyWhat?
Let's use Google-style Python docstrings (OpenMined/SyMPC#28). It can be cool to plug a static documentation website builder into the workflow 😁