sycret icon indicating copy to clipboard operation
sycret copied to clipboard

Write documentation for the user-facing functions

Open tholop opened this issue 4 years ago • 2 comments

Where?

Things to document in priority:

  • The Python interface used by Syft 0.2.x (and soon SyMPC): https://github.com/OpenMined/sycret/blob/master/sycret/fss.py (basically just the keygen and eval functions)
  • Improve the Readme

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 (https://github.com/OpenMined/SyMPC/issues/28). It can be cool to plug a static documentation website builder into the workflow :grin:

tholop avatar Jan 07 '21 00:01 tholop

I'd like to take this one!

nph4rd avatar Jan 07 '21 04:01 nph4rd

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

tholop avatar Jan 07 '21 13:01 tholop