Update doc comments

[utpilla]

Address #2135 (comment)

Changes

• Update doc comments

Please provide a brief description of the changes here.

Merge requirement checklist

• CONTRIBUTING guidelines followed
• Unit tests added/updated (if applicable)
• Appropriate CHANGELOG.md files updated for non-trivial, user-facing changes
• Changes in public API reviewed (if applicable)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.0%. Comparing base (88023d9) to head (0889833).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##            main   #2149     +/-   ##
=======================================
- Coverage   79.0%   79.0%   -0.1%     
=======================================
  Files        121     121             
  Lines      20933   20933             
=======================================
- Hits       16549   16548      -1     
- Misses      4384    4385      +1     

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