Skip to content
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

Create pycoverage extension #12371

Closed
wants to merge 1 commit into from

Conversation

Lonami
Copy link
Contributor

@Lonami Lonami commented May 14, 2024

Subject: introduce a more powerful alternative to the existing coverage extension.

Feature or Bugfix

  • Feature

Purpose

  • The existing coverage extension has certain limitations.
  • For one, I couldn't really get it to work in my project out of the box.
  • But, it also lacks the ability to check that all parameters and return types are documented.

Detail

  • This is currently missing tests. But it seems to work on my project.
  • There might be far better ways to achieve some of the things I'm trying to do (such as, better way to query existing fields, or access the parsed docstrings).
  • I also would like for this to check that all docstrings contain code examples, and that they are syntactically valid.
  • I didn't just update the original code because I felt I was changing too much and it also uses different file formatting. Maybe the current formatting here is wrong though. Maybe it's better to improve that extension.

Relates

@chrisjsewell
Copy link
Member

chrisjsewell commented May 15, 2024

Heya thanks, I feel though it might be better for you to first create this as a third-party extension, in your own repo.
Then you and others can play around with it more, and we could later assess if it warrants going into core

@Lonami Lonami closed this May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants