Skip to content

Conversation

@ssnl
Copy link
Collaborator

@ssnl ssnl commented Mar 23, 2018

Currently examples in index_*_ docs are broken, e.g. http://pytorch.org/docs/master/tensors.html#torch.Tensor.index_add_. This PR fixes the incorrect Example: format in _tensor_docs.py.

cc @zou3519 who discovered this together with me

Copy link
Contributor

@zou3519 zou3519 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@zou3519
Copy link
Contributor

zou3519 commented Mar 23, 2018

What's the difference between Example: and Example::? Is the latter strictly better than the other?

The reason why I'm asking is because a grep for "Example:$ gives a lot of hits in the codebase, but the docs aren't malformed like this in the other places.

@ezyang ezyang merged commit 4dc55a4 into pytorch:master Mar 23, 2018
@ssnl
Copy link
Collaborator Author

ssnl commented Mar 23, 2018 via email

@ssnl ssnl deleted the doc branch March 24, 2018 16:57
sighingnow added a commit to sighingnow/pytorch that referenced this pull request Mar 25, 2018
* upstream/master: (663 commits)
  Fix "command not found" error in perf test (pytorch#5982)
  add pip mkl-devel to the error message when mkl is found but mkl headers are not (pytorch#5984)
  Support batch LowerCholeskyTransform (pytorch#5980)
  Linearly interpolating upsampling fix (pytorch#5927)
  Store perf numbers in S3 (pytorch#5951)
  Modidy setup docs for Windows (pytorch#5981)
  Group Normalization (pytorch#5968)
  [distributions] Implement Power transform (pytorch#5976)
  Disable TestBottleneck test_cuda on Windows (pytorch#5977)
  Fix crash when cat-ing empty cuda tensors (pytorch#5971)
  Update no_unions flag for nanopb gen and update ONNX proto files (pytorch#5972)
  Expose gradients w.r.t. input & weight for conv1d, conv2d, conv3d in Python (pytorch#5408)
  Fixed non-determinate preprocessing on DataLoader (pytorch#4640)
  add AVX2 implementation for sigmoid function (pytorch#5010)
  Implement torch.util.bottleneck (pytorch#5216)
  Remove pragma once from cpp file (pytorch#5965)
  fix mvn docs (pytorch#5967)
  Fix incorrect rendering of Tensor.index_*_ doc examples. (pytorch#5969)
  Implement range for loop in script (pytorch#5827)
  Add windows doc (pytorch#5859)
  ...

# Conflicts:
#	aten/src/TH/generic/THTensorMath.c
#	torch/_tensor_docs.py
#	torch/csrc/generic/methods/TensorCompare.cwrap
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants