Skip to content

Commit

Permalink
revert check docstring(not yet D rule)
Browse files Browse the repository at this point in the history
  • Loading branch information
phi-friday committed Jul 11, 2024
1 parent 375885c commit b374606
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/check_docstrings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# This workflow will install Python dependencies and check docstrings with a single version of Python
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: Check docstrings

on:
push:
branches: [ "master" ]
pull_request:

permissions:
contents: read

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python 3.10
uses: actions/setup-python@v3
with:
python-version: "3.10"
- name: Install Poetry
uses: snok/install-poetry@v1
- name: Install dependencies
run: |
poetry install --with dev
- name: Check docstyle
run : poetry run pydocstyle --convention=numpy --add-select D417 bayes_opt/*
#- name: Run linting
# run : pylint bayes_opt/* --disable=C0103 # ignore no snake_case conformity of arguments

0 comments on commit b374606

Please sign in to comment.