docparams extension considers type comments as type documentation. #6288

AWhetter · 2022-04-13T01:40:51Z

Type of Changes

	Type
	🐛 Bug fix
✓	✨ New feature
	🔨 Refactoring
	📜 Docs

Description

The docparams extension won't raise a missing-type-doc when type annotations are given. This changes means that it also won't raise a missing-type-doc when type comments are given.

Closes #6287

coveralls · 2022-04-13T01:46:24Z

Pull Request Test Coverage Report for Build 3677661165

65 of 68 (95.59%) changed or added relevant lines in 2 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-0.003%) to 95.49%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
pylint/extensions/_check_docs_utils.py	61	64	95.31%

Totals
Change from base Build 3676518720:	-0.003%
Covered Lines:	17700
Relevant Lines:	18536

💛 - Coveralls

Pierre-Sassoulas

Looks great already !

pylint/extensions/_check_docs_utils.py

ChangeLog

pylint/extensions/_check_docs_utils.py

pylint/extensions/docparams.py

pylint/extensions/_check_docs_utils.py

Pierre-Sassoulas · 2022-04-13T07:26:05Z

What do you think of this astroid issue pylint-dev/astroid#1508 @AWhetter ?

Pierre-Sassoulas

LGTM, thank you 👍 I'm going to wait for another review if possible but this is definitely going in 2.16.0

DanielNoord · 2022-10-17T06:56:53Z

pylint/extensions/_check_docs_utils.py

+
+
+def _merge_annotations(
+    annotations: Iterable[astroid.NodeNG], comment_annotations: Iterable[astroid.NodeNG]


We should probably follow the style of importing from nodes instead of astroid here.

Pierre-Sassoulas

The CI fail on the doc is a temporary fail in reaching a twitter link.

Pierre-Sassoulas

Let's merge this 🎉

Pierre-Sassoulas · 2022-12-12T18:04:21Z

@AWhetter the pypi 3.7 tests seems genuine, but also it's on an old interpreter, should we just ignore it ?

AWhetter · 2022-12-12T18:11:21Z

I think the Ellipsis checking could be incorrect in Python 3.7. I'll take a look at fixing it.

codecov · 2023-05-16T13:08:10Z

Codecov Report

Merging #6288 (eb3cc1a) into main (3a741b2) will increase coverage by 0.00%.
The diff coverage is 96.92%.

❗ Current head eb3cc1a differs from pull request most recent head d64c51c. Consider uploading reports for the commit d64c51c to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6288   +/-   ##
=======================================
  Coverage   95.82%   95.83%           
=======================================
  Files         173      173           
  Lines       18387    18428   +41     
=======================================
+ Hits        17619    17660   +41     
  Misses        768      768

Impacted Files	Coverage Δ
pylint/extensions/_check_docs_utils.py	`93.72% <96.72%> (+0.99%)`	⬆️
pylint/extensions/docparams.py	`100.00% <100.00%> (ø)`

... and 6 files with indirect coverage changes

Pierre-Sassoulas · 2023-05-31T04:47:04Z

I tried to add coverage ans force pushed some code but I was out of idea to get the last line @AWhetter :) we're very close to being able to merge

Closes pylint-dev#6287

AWhetter · 2023-06-13T04:17:43Z

@Pierre-Sassoulas Thanks for adding those tests! I've included them again and added a test that covers that final line.
The test failure seems to be happening in the main branch and is unrelated to these changes. So I think that this is ready to merge.

github-actions · 2023-06-13T04:29:22Z

🤖 According to the primer, this change has no effect on the checked open source code. 🤖🎉

This comment was generated for commit d64c51c

Pierre-Sassoulas

Amazing, thank you for covering the last missing part 👍

Pierre-Sassoulas added the Enhancement ✨ Improvement to a component label Apr 13, 2022

Pierre-Sassoulas added this to the 2.14.0 milestone Apr 13, 2022

Pierre-Sassoulas requested changes Apr 13, 2022

View reviewed changes

DanielNoord removed this from the 2.14.0 milestone May 4, 2022

Pierre-Sassoulas added the Waiting on author Indicate that maintainers are waiting for a message of the author label Jul 9, 2022

AWhetter force-pushed the fix_6287 branch 2 times, most recently from 41593ed to 84a8f67 Compare October 14, 2022 23:31

This comment has been minimized.

Sign in to view

AWhetter removed the Waiting on author Indicate that maintainers are waiting for a message of the author label Oct 15, 2022

AWhetter requested a review from Pierre-Sassoulas October 15, 2022 00:21

Pierre-Sassoulas previously approved these changes Oct 15, 2022

View reviewed changes

Pierre-Sassoulas added the Needs review 🔍 Needs to be reviewed by one or multiple more persons label Oct 15, 2022

Pierre-Sassoulas added this to the 2.16.0 milestone Oct 15, 2022

DanielNoord reviewed Oct 17, 2022

View reviewed changes

AWhetter dismissed Pierre-Sassoulas’s stale review via c3e17bc October 20, 2022 19:12

This comment has been minimized.

Sign in to view

Pierre-Sassoulas previously approved these changes Oct 20, 2022

View reviewed changes

Pierre-Sassoulas dismissed their stale review via 26ae702 December 12, 2022 16:19

Pierre-Sassoulas force-pushed the fix_6287 branch from c3e17bc to 26ae702 Compare December 12, 2022 16:19

Pierre-Sassoulas removed the Needs review 🔍 Needs to be reviewed by one or multiple more persons label Dec 12, 2022

Pierre-Sassoulas previously approved these changes Dec 12, 2022

View reviewed changes

This comment has been minimized.

Sign in to view

Pierre-Sassoulas modified the milestones: 2.16.0, 2.17.0 Jan 8, 2023

Pierre-Sassoulas modified the milestones: 2.17.0, 3.0.0 Mar 7, 2023

Pierre-Sassoulas force-pushed the fix_6287 branch from 26ae702 to e6fb005 Compare May 16, 2023 12:53

Pierre-Sassoulas dismissed their stale review via 72873b5 May 16, 2023 12:57

Pierre-Sassoulas modified the milestones: 3.0.0, 3.0.0a7 May 16, 2023

This comment has been minimized.

Sign in to view

Pierre-Sassoulas force-pushed the fix_6287 branch from 72873b5 to 3f0b8ec Compare May 21, 2023 13:54

This comment has been minimized.

Sign in to view

Pierre-Sassoulas force-pushed the fix_6287 branch from 3f0b8ec to eb3cc1a Compare May 22, 2023 03:26

This comment has been minimized.

Sign in to view

AWhetter force-pushed the fix_6287 branch from eb3cc1a to 6f3e234 Compare May 31, 2023 01:18

This comment has been minimized.

Sign in to view

AWhetter force-pushed the fix_6287 branch from 6f3e234 to 48cc14a Compare June 13, 2023 03:25

This comment has been minimized.

Sign in to view

docparams extension considers type comments as type documentation.

d64c51c

Closes pylint-dev#6287

AWhetter force-pushed the fix_6287 branch from 48cc14a to d64c51c Compare June 13, 2023 04:01

Pierre-Sassoulas approved these changes Jun 13, 2023

View reviewed changes

Pierre-Sassoulas merged commit c6d2331 into pylint-dev:main Jun 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docparams extension considers type comments as type documentation. #6288

docparams extension considers type comments as type documentation. #6288

AWhetter commented Apr 13, 2022

coveralls commented Apr 13, 2022 •

edited

Loading

Pierre-Sassoulas left a comment

Pierre-Sassoulas commented Apr 13, 2022

This comment has been minimized.

Pierre-Sassoulas left a comment

DanielNoord Oct 17, 2022

This comment has been minimized.

Pierre-Sassoulas left a comment

Pierre-Sassoulas left a comment

This comment has been minimized.

Pierre-Sassoulas commented Dec 12, 2022

AWhetter commented Dec 12, 2022

codecov bot commented May 16, 2023 •

edited

Loading

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Pierre-Sassoulas commented May 31, 2023

This comment has been minimized.

AWhetter commented Jun 13, 2023

github-actions bot commented Jun 13, 2023

Pierre-Sassoulas left a comment



		def _merge_annotations(
		annotations: Iterable[astroid.NodeNG], comment_annotations: Iterable[astroid.NodeNG]

docparams extension considers type comments as type documentation. #6288

docparams extension considers type comments as type documentation. #6288

Conversation

AWhetter commented Apr 13, 2022

Type of Changes

Description

coveralls commented Apr 13, 2022 • edited Loading

Pull Request Test Coverage Report for Build 3677661165

💛 - Coveralls

Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

Pierre-Sassoulas commented Apr 13, 2022

This comment has been minimized.

Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

DanielNoord Oct 17, 2022

Choose a reason for hiding this comment

This comment has been minimized.

Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

This comment has been minimized.

Pierre-Sassoulas commented Dec 12, 2022

AWhetter commented Dec 12, 2022

codecov bot commented May 16, 2023 • edited Loading

Codecov Report

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Pierre-Sassoulas commented May 31, 2023

This comment has been minimized.

AWhetter commented Jun 13, 2023

github-actions bot commented Jun 13, 2023

Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

coveralls commented Apr 13, 2022 •

edited

Loading

codecov bot commented May 16, 2023 •

edited

Loading