Skip to content
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.

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

FDS small docs fix #2610

Merged
merged 2 commits into from
Nov 16, 2023
Merged

FDS small docs fix #2610

merged 2 commits into from
Nov 16, 2023

Conversation

adam-narozniak
Copy link
Contributor

Issue

  • The version in the conf.py was not updated.
  • The sequence "Partitioners" (the s right after the backtick with no spaces) is misinterpreted and leads to a warning in docs.

Description

Warning: flower/datasets/flwr_datasets/federated_dataset.py:docstring of flwr_datasets.federated_dataset.FederatedDataset:16: WARNING: Inline interpreted text or phrase reference start-string without end-string.

Proposal

  • update the version
  • Rephrase the docs to convey plural.

Before:
(the backticks are present)
image

After:
image

@danieljanes danieljanes merged commit 9ad0639 into main Nov 16, 2023
29 checks passed
@danieljanes danieljanes deleted the fds-docs-fix branch November 16, 2023 12:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants