-
Notifications
You must be signed in to change notification settings - Fork 20
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.
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
Conversation
This will fix a formatting issue in the documentation of the clue object where the sample code is not in the code block.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for catching the docs issue! And thank you for noticing that Pylint was not running on the subfolders. I believe you may have caught something we need to fix on a few other repos as well.
Please see the suggested change below for how to update the build.yml file.
.github/workflows/build.yml
Outdated
([[ ! -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" )) |
There was a problem hiding this comment.
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.
([[ ! -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 )) |
There was a problem hiding this comment.
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.
It looks like there is some change in behavior with PyLint version 2.7.0 that is causing the error. I am not sure which behavior is absolutely correct, but for the scope of this request, keeping it at the older version seems best. |
@AlexColello Good catch, you are correct. This issue was reported by someone else as well. However, I'm pretty sure you're also correct that it's not linting the subfolders - I tested it on another repo with subfolders in examples, and it didn't seem to catch an issue present in a subfoldered example. Please sit tight and I'm going to look into the Pylint update issue tomorrow. Thank you for your patience. |
@kattni I see, that probably means that 2.7 fixed an issue that was hiding the linting errors. Here is the new error for reference
|
That is correct, @AlexColello. I am currently working on our solution. I'll get back to you soon. |
@AlexColello My apologies for letting this slide. We sorted out a solution for the issue. If you want to submit a new PR with the documentation change, it will run with the new Pylint setup and should pass. Again, I'm sorry for neglecting this PR. |
I wanted to fix a minor issue in the docs where a code block in a comment did not completely enclose the sample code. Along the way I also ended up dealing with an issue where PyLint found too many duplicate lines of code between clue_ams_remote.py and clue_ams_remote_advanced.py.