Skip to content

Fixed minor formatting in docs #39

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

Closed
wants to merge 3 commits into from
Closed

Fixed minor formatting in docs #39

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
91674a1
Fixed comment indentation
AlexColello Feb 22, 2021
c84145f
Split linting for examples and advanced examples into two steps
AlexColello Feb 22, 2021
66b9f8a
Pinned PyLint version
AlexColello Feb 22, 2021
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
3 changes: 2 additions & 1 deletion .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@ jobs:
- name: PyLint
run: |
pylint $( find . -path './adafruit*.py' )
([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace $( find . -path "./examples/*.py" ))
([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace $( find . -name "advanced_examples" -prune -false -o -path "./examples/*.py" ))
([[ ! -d "examples/advanced_examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace $( find . -path "./examples/advanced_examples/*.py" ))
Copy link
Contributor

Choose a reason for hiding this comment

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

Please try the following instead of creating a new line to check the examples subfolder. It worked for me locally, but I would appreciate it if you could test it as well.

Suggested change
([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace $( find . -name "advanced_examples" -prune -false -o -path "./examples/*.py" ))
([[ ! -d "examples/advanced_examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace $( find . -path "./examples/advanced_examples/*.py" ))
([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace $( find examples -name \*.py ))

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I tested that change in AlexColello@3f957cb, but it causes the same error as in 91674a1. I checked the find command and both this and the original produce the same results, so I don't think that is the issue.

- name: Build assets
run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location .
- name: Archive bundles
Expand Down
2 changes: 1 addition & 1 deletion adafruit_clue.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -960,5 +960,5 @@ def simple_text_display( # pylint: disable=too-many-arguments

.. code-block:: python

from adafruit_clue import clue
from adafruit_clue import clue
"""