Skip to content

refactor(framework): Align user-facing docstrings with reStructuredText (RST) syntax #6855

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

Draft
panh99 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

refactor(framework): Align user-facing docstrings with reStructuredText (RST) syntax #6855

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
2 changes: 1 addition & 1 deletion framework/py/flwr/common/record/array.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ class Array(InflatableObject):
A dataclass containing serialized data from an array-like or tensor-like object
along with metadata about it. The class can be initialized in one of three ways:

1. By specifying explicit values for `dtype`, `shape`, `stype`, and `data`.
1. By specifying explicit values for ``dtype``, ``shape``, ``stype``, and ``data``.
2. By providing a NumPy ndarray (via the `ndarray` argument).
3. By providing a PyTorch tensor (via the `torch_tensor` argument).
Comment on lines +58 to 60
Copy link

Copilot AI Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This docstring line was updated to RST inline-literal syntax (double backticks), but the adjacent list items still use Markdown-style single backticks (e.g., ndarray, torch_tensor). Since Sphinx/RST will render single backticks as emphasis, these should be updated to RST inline literals (ndarray, torch_tensor) for consistent user-facing docs output.

Copilot uses AI. Check for mistakes.

Expand Down
Loading