[doc] Broken formatting for the function signature of torch.randperm

[kshitij12345]

📚 Documentation

Documentation does not mention anything about randperm accepting a generator.
https://pytorch.org/docs/stable/generated/torch.randperm.html

Following works:

>>> torch.randperm(10, generator=g)

Also,

pytorch/aten/src/ATen/native/native_functions.yaml

Lines 3073 to 3086 in 321b988

	- func: randperm(int n, *, ScalarType? dtype=None, Layout? layout=None, Device? device=None, bool? pin_memory=None) -> Tensor
	use_c10_dispatcher: hacky_wrapper_for_legacy_signatures
	- func: randperm.generator(int n, *, Generator? generator, ScalarType? dtype=None, Layout? layout=None, Device? device=None, bool? pin_memory=None) -> Tensor
	use_c10_dispatcher: hacky_wrapper_for_legacy_signatures
	- func: randperm.out(int n, *, Tensor(a!) out) -> Tensor(a!)
	use_c10_dispatcher: hacky_wrapper_for_legacy_signatures
	- func: randperm.generator_out(int n, *, Generator? generator, Tensor(a!) out) -> Tensor(a!)
	use_c10_dispatcher: hacky_wrapper_for_legacy_signatures
	dispatch:
	CPU: randperm_out_cpu
	CUDA: randperm_out_cuda

cc @jlin27 @mruberry

[zou3519]

We would accept a PR to fix this (unless it turns out that there's a reason why this isn't documented)

[mruberry]

cc @ngimel - is there a better label or person to cc for this?

[ngimel]

cc @pbelevich, I don't think there's a reason for it to be undocumented. See also #44714 for some corner cases where generator argument is ignored causing segfaults.

[kshitij12345]

It (documentation for generator arg) is fixed in #47231

Correct documentation is available on docs for master: https://pytorch.org/docs/master/generated/torch.randperm.html?highlight=torch%20randperm#torch.randperm

The formatting of the function signature looks to be broken,