Skip to content

Add Docstrings to ./torch/_refs/__init__.py, ./torch/_refs/special/__init__.py, ./torch/masked/_ops.py #113082

@svekars

Description

@svekars

Add docstrings on the following lines. Follow these docstring guidelines. A docstring should have:

  • A short one-sentence description in imperative mode.
  • A longer description.
  • A list of associated Args.
  • A return value (for functions)
  • An example
    Follow the existing patterns in the file you are editing. After adding the docstring, run:
lintrunner -a
  • File: ./torch/_refs/special/__init__.py, Line: 231
  • File: ./torch/masked/_ops.py, Line: 1479
  • File: ./torch/_refs/__init__.py, Line: 1080
  • File: ./torch/_refs/__init__.py, Line: 1090
  • File: ./torch/_refs/__init__.py, Line: 1098
  • File: ./torch/_refs/__init__.py, Line: 1106

cc @carljparker

Metadata

Metadata

Assignees

Labels

mediumLabel for medium docathon tasksmodule: docsRelated to our documentation, both in docs/ and docblockstriagedThis issue has been looked at a team member, and triaged and prioritized into an appropriate module

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions