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

Add ability to ignore :nodoc: methods in Typing rules #557

Merged
merged 3 commits into from
Jan 31, 2025

Conversation

Sija
Copy link
Member

@Sija Sija commented Jan 30, 2025

Adds new NodocMethods configuration option for ignoring :nodoc: methods to the below-mentioned rules (disabled by default - i.e. :nodoc: methods won't be checked).

  • Typing/MethodReturnTypeRestriction
  • Typing/MethodParameterTypeRestriction

@Sija Sija added this to the 1.7.0 milestone Jan 30, 2025
@Sija Sija requested a review from veelenga January 30, 2025 16:45
@Sija Sija self-assigned this Jan 30, 2025
@Sija Sija force-pushed the add-nodoc-methods-exclude-option branch from 28c8b22 to ae6f23f Compare January 31, 2025 13:37
Adds new `NodocMethods` option in rules:

- `Typing/MethodReturnTypeRestriction`
- `Typing/MethodParameterTypeRestriction`
@Sija Sija force-pushed the add-nodoc-methods-exclude-option branch from ae6f23f to 126fb0f Compare January 31, 2025 13:44
Copy link
Member

@veelenga veelenga left a comment

Choose a reason for hiding this comment

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

lgtm

@Sija Sija merged commit e8d0424 into master Jan 31, 2025
3 of 4 checks passed
@Sija Sija deleted the add-nodoc-methods-exclude-option branch January 31, 2025 15:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants