feat(kubernetes): improve docstrings for methods

[pedrooot]

Description

This pull request introduces comprehensive documentation for the KubernetesProvider class in prowler/providers/kubernetes/kubernetes_provider.py. The changes include detailed docstrings for the class, its attributes, and its methods, providing clear descriptions, expected arguments, return values, exceptions, and usage examples.

Documentation Enhancements:

• Added a class-level docstring to KubernetesProvider, detailing its attributes and methods.
• Expanded the __init__ method docstring to include exceptions, return values, and usage examples. [1] [2]
• Enhanced the setup_session method docstring with exceptions.
• Improved the test_connection method docstring by adding exceptions and usage examples.
• Updated docstrings for various methods (search_and_save_roles, get_context_user_roles, get_all_namespaces, get_pod_current_namespace, and print_credentials) to include exceptions and usage examples. [1] [2] [3] [4] [5]

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.91%. Comparing base (344d541) to head (b6875df).
Report is 3 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5717      +/-   ##
==========================================
- Coverage   89.94%   89.91%   -0.03%     
==========================================
  Files        1124     1124              
  Lines       34815    34815              
==========================================
- Hits        31313    31305       -8     
- Misses       3502     3510       +8     

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