feat(gcp): improve docstrings

[pedrooot]

Description

This pull request enhances the GcpProvider class by adding comprehensive docstrings to its methods and attributes. These additions improve the documentation and usability of the class by detailing the purpose, arguments, return values, exceptions, and usage examples for each method.

Enhancements to documentation:

• prowler/providers/gcp/gcp_provider.py: Added detailed class-level docstring to the GcpProvider class, describing its attributes and methods.

• prowler/providers/gcp/gcp_provider.py: Added docstrings to the __init__, setup_session, test_connection, get_projects, update_projects_with_organizations, is_project_matching, validate_static_arguments, and validate_project_id methods to include descriptions of arguments, return values, exceptions, and usage examples. [1] [2] [3] [4] [5] [6] [7] [8]

Checklist

• Are there new checks included in this PR? Yes / No
  • If so, do we need to update permissions for the provider? Please review this carefully.
• Review if the code is being covered by tests.
• Review if code is being documented following this specification https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings
• Review if backport is needed.

License

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5716      +/-   ##
==========================================
- Coverage   89.94%   89.92%   -0.02%     
==========================================
  Files        1124     1128       +4     
  Lines       34815    35182     +367     
==========================================
+ Hits        31313    31638     +325     
- Misses       3502     3544      +42     

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