Corrects and enhances user API class documentation (CNX-9172)

[jsdbroughton]

In the User Resource class documentation and method docstrings, the changes include:

1. Clarification of Method Purposes: Each method's docstring now clearly states its purpose and the context in which it should be used.
2. Detailed Parameter Descriptions: Each method's argument parameters are now explicitly described, including their data types and whether they are optional.
3. Return Value Descriptions: The expected return values for each method are now properly documented.
4. Correction of Typos and Inaccuracies: Any typos, inaccuracies, or misleading information in the original docstrings have been corrected to ensure the documentation accurately reflects the functionality of the Resource class.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.32%. Comparing base (b22ba1f) to head (b28db08).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #334   +/-   ##
=======================================
  Coverage   90.32%   90.32%           
=======================================
  Files          95       95           
  Lines        5633     5633           
=======================================
  Hits         5088     5088           
  Misses        545      545           

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