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

Remove Args from class definition docstring #70

Merged
merged 2 commits into from
Dec 17, 2022

Conversation

cmsirbu
Copy link
Contributor

@cmsirbu cmsirbu commented Oct 3, 2022

Remove Args section from class definition docstring - the __init__ docstring explains its arguments already.

Fixes the following warnings:

WARNING  -  griffe: nautobot_plugin_nornir/plugins/credentials/env_vars.py:17: Parameter
            'MixinNautobotORMCredentials' does not appear in the function signature
WARNING  -  griffe: nautobot_plugin_nornir/plugins/credentials/settings_vars.py:14: Parameter
            'MixinNautobotORMCredentials' does not appear in the function signature

Griffe expects Args syntax for Returns sections (thanks @glennmatthews !) - fixing the following warnings:

WARNING  -  griffe: nautobot_plugin_nornir/plugins/inventory/nautobot_orm.py:174: No type or annotation for
            returned value 'dict'
WARNING  -  griffe: nautobot_plugin_nornir/plugins/inventory/nautobot_orm.py:232: No type or annotation for
            returned value 'list'

@cmsirbu cmsirbu requested a review from jeffkala as a code owner October 3, 2022 19:27
@itdependsnetworks itdependsnetworks merged commit 1ea500c into nautobot:develop Dec 17, 2022
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.

3 participants