Skip to content

Improved docstrings for Elemwise functions #1259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Improved docstrings for Elemwise functions #1259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a220e5
[pre-commit.ci] pre-commit autoupdate
pre-commit-ci[bot] Feb 24, 2025
7583242
Improved docstrings for Elemwise functions
twiecki Mar 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ repos:
- id: sphinx-lint
args: ["."]
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.7.3
rev: v0.9.7
hooks:
- id: ruff
args: ["--fix", "--output-format=full"]
Expand Down
6 changes: 4 additions & 2 deletions pytensor/tensor/elemwise.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -847,7 +847,7 @@ def _c_all(self, node, nodename, inames, onames, sub):
# for each input:
# same as range(ndim), but with 'x' at all broadcastable positions
orders = [
[s == 1 and "x" or i for i, s in enumerate(input.type.shape)]
[(s == 1 and "x") or i for i, s in enumerate(input.type.shape)]
for input in inputs
]

Expand Down Expand Up @@ -1671,8 +1671,10 @@ def construct(symbol):
scalar_op = getattr(scalar, symbolname)
rval = Elemwise(scalar_op, nfunc_spec=(nfunc and (nfunc, nin, nout)))

# Set the docstring to be just the original function's docstring
# without appending the generic Elemwise docstring
if getattr(symbol, "__doc__"):
rval.__doc__ = symbol.__doc__ + "\n\n " + rval.__doc__
rval.__doc__ = symbol.__doc__

# for the meaning of this see the ./epydoc script
# it makes epydoc display rval as if it were a function, not an object
Expand Down
Loading