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

[Documentation][import handler] Add docstrings to module_utils/import_handler.py #1332

Conversation

IsaacVRey
Copy link
Contributor

@IsaacVRey IsaacVRey commented Mar 25, 2024

SUMMARY

Update docstrings on import_handler to the numpy standard
This addresses part of #1311

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

import_handler.py

ADDITIONAL INFORMATION

@IsaacVRey IsaacVRey changed the title Documentation/module utils/import handler [Documentation][import handler] Mar 29, 2024
@IsaacVRey IsaacVRey changed the title [Documentation][import handler] [Documentation][import handler] Add docstrings to module_utils/import_handler.py Mar 29, 2024
@IsaacVRey IsaacVRey marked this pull request as ready for review March 29, 2024 18:08
Copy link
Collaborator

@rexemin rexemin left a comment

Choose a reason for hiding this comment

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

Looks good, just pointed out a little typo.

@@ -71,10 +109,36 @@ def method(*args, **kwargs):

class MissingImport(object):
def __init__(self, import_name=""):
"""Error when it is unable to import a module due it being missing.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Just a little typo: instead of ...module due it being missing., it should be ...module due to it being missing.

Copy link
Collaborator

Choose a reason for hiding this comment

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

done

Copy link
Collaborator

@richp405 richp405 left a comment

Choose a reason for hiding this comment

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

I'll approve pending Ivan's note: one minor grammar fix.

@fernandofloresg fernandofloresg requested a review from rexemin April 19, 2024 17:00
@fernandofloresg fernandofloresg merged commit 8da1199 into ansible-collections:dev Apr 19, 2024
4 checks passed
@fernandofloresg fernandofloresg deleted the documentation/module-utils/import-handler branch April 19, 2024 19:29
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.

4 participants