pytensor icon indicating copy to clipboard operation
pytensor copied to clipboard

DOC: Documentation for pymc.math.concatenate refers to `join` which is not documented.

Open DrEntropy opened this issue 1 year ago • 0 comments

Issue with current documentation:

https://www.pymc.io/projects/docs/en/stable/api/generated/pymc.math.concatenate.html which is based on the docstring for pytensor.math.concatenate says :

Alias for `join`(axis, *tensor_list).

This function is similar to `join`, but uses the signature of
numpy's concatenate function.

This is not very helpful, because join is not documented as far as I can determine.

Idea or request for content:

I suggest instead that the docstring be based on the documentation at https://pytensor.readthedocs.io/en/latest/library/tensor/basic.html#pytensor.tensor.concatenate

DrEntropy avatar Feb 16 '24 17:02 DrEntropy