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

feat(azure): improve docstrings #5715

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

pedrooot
Copy link
Member

Description

This pull request includes an enhancement to the AzureProvider class in the prowler/providers/azure/azure_provider.py file. The main change is the addition of usage examples to the __init__ method's docstring, demonstrating various ways to instantiate the AzureProvider class.

Enhancements to documentation:

  • prowler/providers/azure/azure_provider.py: Added detailed usage examples for different authentication methods (static credentials, Azure CLI, Service Principal environment, interactive browser, and managed identity) to the __init__ method's docstring.

Checklist

License

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@pedrooot pedrooot requested review from a team as code owners November 11, 2024 12:51
@github-actions github-actions bot added the provider/azure Issues/PRs related with the Azure provider label Nov 11, 2024
Copy link

codecov bot commented Nov 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.88%. Comparing base (344d541) to head (db757ec).
Report is 11 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5715      +/-   ##
==========================================
- Coverage   89.94%   89.88%   -0.06%     
==========================================
  Files        1124     1128       +4     
  Lines       34815    35182     +367     
==========================================
+ Hits        31313    31622     +309     
- Misses       3502     3560      +58     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
provider/azure Issues/PRs related with the Azure provider
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant