pymc-devs / pymc-devs/pytensor

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

Open
#648 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
Python
Stars
644
Forks
208
Avg merge
2d 14h
Merged PRs (30d)
16

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Search the PyTensor source for the pymc.math.concatenate or pytensor.math.concatenate docstring, then compare its current description with the linked PyTensor concatenate documentation. Update the documentation so it explains the function without relying on the undocumented join reference, and verify that the generated API page reflects the revised text.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.