Commit message (Collapse) | Author | Age | Files | Lines | |
---|---|---|---|---|---|
* | [doc] Apply black on the documentation where it makes sense (#8650) | Pierre Sassoulas | 2023-05-02 | 13 | -12/+15 |
| | | | Co-authored-by: Daniel van Noord <13665637+DanielNoord@users.noreply.github.com> | ||||
* | [PyCQA migration] Upgrade links to the repositories in code and doc (#8514) | Pierre Sassoulas | 2023-03-29 | 1 | -1/+1 |
| | |||||
* | [doc] Add an example for 'missing-format-string-key' (#8379) | Pierre Sassoulas | 2023-03-03 | 3 | -2/+14 |
| | |||||
* | [doc] missing-any-param-doc, missing-kwon, subprocess-popen-preexec-fn, ↵ | Ollie | 2023-02-14 | 7 | -4/+23 |
| | | | | | | typevar-name-incorrect-variance (#8288) Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com> | ||||
* | Add doc for message missing-final-newline (#8195) | Robert Hofer | 2023-02-06 | 4 | -2/+23 |
| | | | Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com> | ||||
* | missing-parentheses-for-call-in-test] Generate imaginative example with GhatGPT | Pierre Sassoulas | 2023-02-05 | 3 | -2/+16 |
| | | | | | | | | | | | | | | | | | | | | | | | | Prompt: Could you give me an example of bad code raising a 'missing-parentheses-for-call-in-test' message in pylint Could you make it more lively, the name is very generic ? That's kinda expected and boring, could you be more imaginative ? Also I don't think it should return a string, it's supposed to return a boolean. You need to add a ``# [missing-parentheses-for-call-in-test]`` on the line the actual message would be raised, could you update the bad example, please ? Final result: def is_it_a_good_day(): import random return random.choice([True, False]) if is_it_a_good_day: # [missing-parentheses-for-call-in-test] print("Today is a good day!") In this code, the line if is_it_a_good_day: would raise the "missing-parentheses-for-call-in-test" message, because Pylint is expecting to see a function call in the test expression of an if statement, but there are no parentheses after is_it_a_good_day. To correct this, you can add parentheses to make it a function call, as shown in the corrected code in my previous answer. | ||||
* | [doc] clearer message for 'method-cache-max-size-none' warning (#7861) | Pierre Sassoulas | 2022-11-29 | 2 | -3/+9 |
| | | | Refs #7857 | ||||
* | [doc] Document some messages where the code is not the problem (#7713) | Pierre Sassoulas | 2022-11-05 | 2 | -2/+1 |
| | |||||
* | Upgrade the documentation, fix 'magic-value-comparison' doc (#7711) | Pierre Sassoulas | 2022-11-05 | 3 | -0/+0 |
| | |||||
* | Take 'accept-no-raise-doc' option into account (#7581) | Brice Chardin | 2022-10-28 | 1 | -0/+3 |
| | | | | | | | | | Check the accept-no-raise-doc option when the docstring has matching sections (Fixes #7208) Defaut value for accept-no-raise-doc is True, but tests in `missing_doc_required_Sphinx.py` assume that this option is set to False. Co-authored-by: Brice Chardin <brice.chardin@ensma.fr> | ||||
* | Add docs for modified-* messages and a couple others (#7669) | Dani Alcala | 2022-10-24 | 16 | -10/+53 |
| | |||||
* | Add `magic-number` checker for comparison with literals (#7526) | orSolocate | 2022-10-22 | 3 | -0/+27 |
| | | | Co-authored-by: Or Bahari <or.bahari@samsung.com> | ||||
* | Use the default config in the messages documentation tests | Daniël van Noord | 2022-07-07 | 3 | -0/+6 |
| | |||||
* | Add documentation examples for `method-hidden` (#7042) | Julthep Nandakwang | 2022-06-25 | 3 | -2/+12 |
| | | | | Co-authored-by: Vladyslav Krylasov <vladyslav.krylasov@gmail.com> Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com> | ||||
* | Add documentation examples for `misplaced-format-function` (#7043) | Julthep Nandakwang | 2022-06-25 | 3 | -2/+2 |
| | | | Co-authored-by: Vladyslav Krylasov <vladyslav.krylasov@gmail.com> | ||||
* | [ADD] missing-timeout: Used when a method call an external request (#6780) | Moises Lopez - https://www.vauxoo.com/ | 2022-06-23 | 3 | -0/+16 |
| | | | | | | | | | | | | | | | | | | | | | | | Calling external request needs to use timeout in order to avoid waiting for a long time You can even reproduce the case using deelay.me e.g. ```python import requests response = requests.get("https://deelay.me/5000/http://localhost:80") # It will spend 5s response = requests.get("https://deelay.me/5000/http://localhost:80", timeout=2) # timeout response = requests.get("https://deelay.me/1000/http://localhost:80", timeout=2) # fine ``` After 2s if the request doesn't have response it raises the following exception requests.exceptions.ReadTimeout: HTTPSConnectionPool(host='deelay.me', port=443): Read timed out. (read timeout=2) But if it responses <=1s it is fine Now you can test the same but using a bigger delay | ||||
* | Add `misplaced-bare-raise` example (#6926) | Harutaka Kawamura | 2022-06-12 | 4 | -2/+7 |
| | | | | Signed-off-by: harupy <hkawamura0130@gmail.com> Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com> | ||||
* | Add `multiple-constructor-doc` example (#6921) | Harutaka Kawamura | 2022-06-12 | 4 | -2/+30 |
| | |||||
* | Add `mixed-format-string` example (#6920) | Harutaka Kawamura | 2022-06-12 | 3 | -2/+3 |
| | |||||
* | Add `multiple-imports` example (#6863) | Harutaka Kawamura | 2022-06-05 | 3 | -2/+3 |
| | | | Exclude multiple-imports/bad.py from isort | ||||
* | Add missing-format-attribute example (#6850) | Harutaka Kawamura | 2022-06-05 | 3 | -2/+2 |
| | | | Co-authored-by: Vladyslav Krylasov <vladyslav.krylasov@gmail.com> | ||||
* | Generate the data message directories with an advert for potential ↵ | Pierre Sassoulas | 2022-05-26 | 38 | -0/+38 |
| | | | | contributors (#6702) | ||||
* | Use main instead of master as main checker name (#6569) | Daniël van Noord | 2022-05-10 | 4 | -4/+4 |
| | | | Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com> | ||||
* | Migrate return type to annotations in missing-yield-doc example (#6400) | Matus Valo | 2022-04-20 | 1 | -2/+5 |
| | |||||
* | Added missing-yield-type-doc message example (#6345) | Matus Valo | 2022-04-20 | 4 | -0/+33 |
| | |||||
* | Added missing-return-type-doc message example (#6343) | Matus Valo | 2022-04-19 | 4 | -0/+20 |
| | |||||
* | Added missing-return-doc message example (#6342) | Matus Valo | 2022-04-19 | 4 | -0/+19 |
| | |||||
* | Added missing-raises-doc message example (#6341) | Matus Valo | 2022-04-19 | 2 | -0/+17 |
| | | | Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com> | ||||
* | Migrate to type annotations | Matus Valo | 2022-04-19 | 2 | -5/+2 |
| | |||||
* | Added missing-type-doc message example | Matus Valo | 2022-04-19 | 2 | -0/+15 |
| | |||||
* | Remove types in docstring | Matus Valo | 2022-04-19 | 2 | -2/+2 |
| | |||||
* | Added details.rst | Matus Valo | 2022-04-19 | 1 | -0/+1 |
| | |||||
* | Added pylintrc file | Matus Valo | 2022-04-19 | 1 | -0/+5 |
| | |||||
* | Added missing-yield-doc message example | Matus Valo | 2022-04-19 | 2 | -0/+21 |
| | |||||
* | Migrated example missing-param-doc to type annotations | Matus Valo | 2022-04-19 | 2 | -5/+2 |
| | |||||
* | Rename ``cache-max-size-none`` and check ``functools.cache`` (#6182) | Daniël van Noord | 2022-04-19 | 2 | -0/+22 |
| | | | Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com> | ||||
* | Added missing-param-doc message example | Matus Valo | 2022-04-19 | 2 | -0/+14 |
| | |||||
* | Added missing-function-docstring message example (#6248) | Matus Valo | 2022-04-10 | 2 | -0/+11 |
| | |||||
* | Added missing-class-docstring message example (#6250) | Matus Valo | 2022-04-10 | 2 | -0/+11 |
| | |||||
* | Added missing-module-docstring message example (#6249) | Matus Valo | 2022-04-10 | 2 | -0/+11 |
| | |||||
* | Added misplaced-future message example (#6243) | Matus Valo | 2022-04-09 | 2 | -0/+6 |
| | | | Co-authored-by: Vladyslav Krylasov <vladyslav.krylasov@gmail.com> | ||||
* | Assert that links in related.rst are a list | Daniël van Noord | 2022-04-07 | 1 | -2/+2 |
| | |||||
* | fix link in `missing-format-argument` | Gunung P. Wibisono | 2022-04-02 | 1 | -2/+2 |
| | | | fix link to use for `missing-format-argument` in `related.rst` | ||||
* | Add example for `missing-format-argument-key` message documentation (#6115) | Gunung P. Wibisono | 2022-04-02 | 3 | -0/+4 |