Skip to content

🧹 fix docstrings for gates and return_partial #112

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

Merged
refraction-ray merged 1 commit into from
May 14, 2026
Merged

🧹 fix docstrings for gates and return_partial #112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 2 additions & 3 deletions tensorcircuit/gates.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,10 +229,9 @@ def num_to_tensor(*num: Union[float, Tensor], dtype: Optional[str] = None) -> An
:type num: Union[float, Tensor]
:param dtype: dtype of the output Tensors
:type dtype: str, optional
:return: List of Tensors
:rtype: List[Tensor]
:return: List of Tensors or a single Tensor
:rtype: Union[List[Tensor], Tensor]
"""
# TODO(@YHPeter): fix __doc__ for same function with different names

l = []
if dtype is None:
Expand Down
4 changes: 2 additions & 2 deletions tensorcircuit/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ def return_partial(

:param f: The function to be applied this method
:type f: Callable[..., Any]
:param return_partial: The ith parts of original output along the first axis (axis=0 or dim=0)
:type return_partial: Union[int, Sequence[int]]
:param return_argnums: The ith parts of original output along the first axis (axis=0 or dim=0)
:type return_argnums: Union[int, Sequence[int]]
:return: The modified callable function
:rtype: Callable[..., Any]
"""
Expand Down
Loading