Skip to content

Write documentation for the user-facing functions #2

@tholop

Description

@tholop

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 😁

Metadata

Metadata

Assignees

Labels

Good first issue 🎓Perfect for beginners, welcome to OpenMined!Type: Documentation 📚Improvements or additions in documentation for some file, feature, or codebase

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions