Pysyft: Add documentation to the existing code base

Created on 15 Aug 2019  路  3Comments  路  Source: OpenMined/PySyft

Is your feature request related to a problem? Please describe.
It would be great, as suggested by @iamtrask, to add documentation to the existing code base so that the code would be easier to understand, especially to new users.

Describe the solution you'd like
Ideally this tasks should be broken down into smaller PR's focusing on the different parts of the code base, such as the serde utility, or the tests.

Additional context
Would be a great way to contributors to gain familiarity with the PySyft code base.

Good first issue Status Type

Most helpful comment

Note that MANY people can pick up this issue. We will likely never close it.

Steps:

1) fork the repo into your own github
2) clone your fork down to your local filesystem
3) look for a part of the codebase that isn't documented
4) read the code and figure out what's going on (this is the hard part)
5) add inline documentation using the correct style
6) commit and push your code to your fork
7) create a pull request back into the main PySyft (which you can do using th big green button on Github"

All 3 comments

Note that MANY people can pick up this issue. We will likely never close it.

Steps:

1) fork the repo into your own github
2) clone your fork down to your local filesystem
3) look for a part of the codebase that isn't documented
4) read the code and figure out what's going on (this is the hard part)
5) add inline documentation using the correct style
6) commit and push your code to your fork
7) create a pull request back into the main PySyft (which you can do using th big green button on Github"

Note that MANY people can pick up this issue. We will likely never close it.

Steps:

  1. fork the repo into your own github
  2. clone your fork down to your local filesystem
  3. look for a part of the codebase that isn't documented
  4. read the code and figure out what's going on (this is the hard part)
  5. add inline documentation using the correct style
  6. commit and push your code to your fork
  7. create a pull request back into the main PySyft (which you can do using th big green button on Github"

since the hard part is step 4. Provide more detail arch is helpful.

This issue has been marked stale because it has been open 30 days with no activity. Leave a comment or remove the stale label to unmark it. Otherwise, this will be closed in 7 days.

Was this page helpful?
0 / 5 - 0 ratings