diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 782e674b90..dd9c1f8b3d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -56,7 +56,7 @@ information on using pull requests. ### Coding Style -* Fromat your changes. +#### Fromat your changes * Install [yapf](https://pypi.org/project/yapf/). @@ -68,7 +68,7 @@ information on using pull requests. | xargs yapf --in-place ``` -* Lint your changes. +#### Lint your changes * Install [pylint](https://pypi.org/project/pylint/). diff --git a/docs/design/package_structure.md b/docs/design/package_structure.md index 36fe94e771..9cb6f9f151 100644 --- a/docs/design/package_structure.md +++ b/docs/design/package_structure.md @@ -35,7 +35,7 @@ The TFF API that that is *not* exposed in the TFF #### TFF Python package The Python [package](https://pypi.org/project/tensorflow-federated/) distributed -on [PyPI](https://pypi.org). +on https://pypi.org. Please be aware, the Python package contains both [public TFF API](#public-tff-api) and [private TFF API](#private-tff-api) and it