frozenleaves/pytorch
1
0
Fork 0
mirror of https://github.com/pytorch/pytorch.git synced 2025-10-20 12:54:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

Remove duplicate note

Joel Schlosser
2021-10-29 11:27:08 -04:00
parent 6ad563eb60
commit 5593aac424
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
torch.nn-Module-Documentation-Style-Guide.md

@ -1,4 +1,4 @@
The purpose of this style guide is to provide guidance for writing torch.nn module documentation. It is purposefully strongly opinionated to keep documentation across modules consistent and readable. It describes which sections should be present for each module, as well as formatting details that should always be followed. Note that Google-style doc strings are utilized throughout the Python source code.
The purpose of this style guide is to provide guidance for writing torch.nn module documentation. It is purposefully strongly opinionated to keep documentation across modules consistent and readable. It describes which sections should be present for each module, as well as formatting details that should always be followed.
## Module Docstring Formatting
Module docstrings should match the following format. Note that Google-style doc strings are utilized throughout the Python source code.