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 the baseline template docstrings #1983

Merged
merged 6 commits into from
Jul 4, 2023

Conversation

adam-narozniak
Copy link
Member

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

Issue

The template for baselines has comments at the top of the files instead of docstrings. It makes the tests that have to be added fail.

Description

NA

Related issues/PRs

NA

Proposal

Change the comments to docstrings that meet the future test requirements.

Description

Fix:

  • D100 Missing docstring in public module
  • D401 First line of docstring should be in imperative mood:
  • D404 First word of the docstring should not be "This"
  • E501 Line too long
  • docstring formatting (using the formatting script).

@jafermarq
Copy link
Contributor

looks good to me!

@adam-narozniak adam-narozniak enabled auto-merge (squash) July 3, 2023 07:22
@adam-narozniak adam-narozniak merged commit 6a29eb1 into main Jul 4, 2023
@adam-narozniak adam-narozniak deleted the fix-baseline-template-docstrings branch July 4, 2023 13:12
tanertopal added a commit that referenced this pull request Jul 5, 2023
* main:
  Remove line with typo from script (#2001)
  Fix simulation error caused by Pydantic version in Ray (#2002)
  Update mxnet examples dependency versions (#1982)
  Update torch version in pyproject.toml files (#1993)
  Update tensorflow examples dependency versions (#1984)
  Fix the baseline template docstrings (#1983)
  Fix Baselines CI PyLint error by using Resampling (#1998)
  Make tensorflow optional when using tensorboard (#1879)
  Update dependencies for MXNet example (#1988)
  Fix `starlette` vulnerability (#1992)
  Fix vulnerability detected by Dependabot (#1990)
  Fix dependabot critical errors (#1989)
  Add Ruff UP check (#1946)
  Update torch examples dependency versions (#1981)
  Remove && from the end of lines in test.sh (#1979)
  Baselines docs updates (#1977)
  Fixes GitHub CI issue because of behaviour change (#1976)
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.

3 participants