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

Add explanatory inline comments to Python example programs [DOCS] #18

Open
Skitzzy opened this issue Apr 22, 2024 · 0 comments
Open

Add explanatory inline comments to Python example programs [DOCS] #18

Skitzzy opened this issue Apr 22, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@Skitzzy
Copy link

Skitzzy commented Apr 22, 2024

**What section of the docs could be improved? **
The entire collection of the Nillion Python Starter programs.

What part(s) of the docs would you like to see updated?
Comments which explain which parts of the outputs and bits of information are available to which parties based on the definitions. Adding some inline comments to, for example, the honest voting program in the form of # result_c0 stores y information, and can be viewed by x party would be really helpful.

Additional context
I was trying to explore what is possible currently with Nillion, and the Python examples were my go to as I assume they will be for many others. Unfortunately it's still confusing at the moment to understand what exactly the examples are accomplishing without switching back and forth between the python client reference

@Skitzzy Skitzzy added the documentation Improvements or additions to documentation label Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant