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.

Sign up for GitHub

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

Jump to bottom

Increase Documentation Coverage #458

Open
sdtblck opened this issue Nov 7, 2021 · 1 comment
Open

Increase Documentation Coverage #458

sdtblck opened this issue Nov 7, 2021 · 1 comment
Labels
feature request New feature or request

Comments

@sdtblck
Copy link
Contributor

sdtblck commented Nov 7, 2021

Some of our code is fairly underdocumented to say the least.

Where possible, it would be good to:

  • Add input / output typehints to all functions
  • Add docstrings with at least a short description of the function's purpose, and at best a description of the input and output variables as well.
  • Integrate torchtyping
@sdtblck sdtblck added the feature request New feature or request label Nov 7, 2021
@StellaAthena StellaAthena mentioned this issue Feb 25, 2022
Open
@slash-under
Copy link
Contributor

Initial torchtyping integration is occurring in #600

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
feature request New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@sdtblck @slash-under