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

Fix D401 First line of docstring should be in imperative mood #1924

Merged
merged 9 commits into from
Jun 14, 2023

Conversation

adam-narozniak
Copy link
Member

@adam-narozniak adam-narozniak commented Jun 14, 2023

Fix D401 - First line of docstring should be in imperative mood.

  • Mainly remove (s) e.g. Returns -> Return.
  • Rewrite/add the first line.

CAUTION: Please review this PR in the order mentioned #1920 for your easy review process.

@adam-narozniak adam-narozniak changed the title Fix docstrings ruff D401 Fix D401 First line of docstring should be in imperative mood Jun 14, 2023
@adam-narozniak adam-narozniak changed the base branch from fix-docstrings-ruff to main June 14, 2023 11:09
@adam-narozniak adam-narozniak enabled auto-merge (squash) June 14, 2023 12:28
@adam-narozniak adam-narozniak merged commit f10ae78 into main Jun 14, 2023
@adam-narozniak adam-narozniak deleted the fix-docstrings-ruff-D401 branch June 14, 2023 13:21
tanertopal added a commit that referenced this pull request Jun 27, 2023
* main: (314 commits)
  Fix D401 First line of docstring should be in imperative mood (#1924)
  Fix D105 Missing docstring in magic method (#1923)
  Fix D202 No blank lines allowed after function docstring (#1920)
  Fix a minor typo in the documentation (#1922)
  Fix docformatter docstrings (#1919)
  Add SecAggMsg field to Task Message (#1893)
  Ignore typing for Ray to fix CI (#1925)
  Update `mypy` to 1.3.0 and fix typing issues (#1877)
  Upgrade black and docformatter, format ipynb (#1902)
  Updated minor error on the documentation, (3rd config dict print) instead of batch_size prints 2 to local_epochs prints 2 (#1903)
  Avoid CI job to marked as failure if requirements.txt check fails (#1906)
  Make check-requirements-txt.sh optional (#1905)
  Add default address for grpc-rere (#1900)
  Update docs dependencies, fix warnings (#1899)
  Add quickstart iOS documentation (#1897)
  Auto-generate requirements.txt to sync with pyproject.toml automatically (#1873)
  Fix updated formatting (#1890)
  Fix code documentation in aggregate_krum() (#1887)
  Remove redundant warning check for strategies subclassing FedAvg (#1855)
  Reformat server for FedBuff (#1888)
  ...
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