update documentation

[Borda]

Before submitting

• Was this discussed/agreed via a Github issue? (no need for typos and docs improvements)
• Did you read the contributor guideline, Pull Request section?
• Did you make sure to update the docs?
• Did all existing and newly added tests pass locally?

What does this PR do?

improve usability

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in GitHub issues there's a high chance it will not be merged.

---

📚 Documentation preview 📚: https://lit-utilities--430.org.readthedocs.build/en/430/

[Copilot]

Pull Request Overview

This PR improves the documentation quality across multiple utility modules by adding comprehensive docstrings and parameter descriptions. The changes focus on enhancing developer experience through better API documentation.

• Add detailed docstrings with Args, Returns, and Raises sections to previously undocumented functions
• Enhance existing brief docstrings with comprehensive parameter descriptions and usage details
• Improve clarity of function purposes and expected behaviors

Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
src/lightning_utilities/test/warning.py	Enhanced docstring for no_warning_call context manager with parameter details and exception info
src/lightning_utilities/install/requirements.py	Added module-level docstring and comprehensive documentation for requirement parsing functions
src/lightning_utilities/docs/retriever.py	Improved docstrings for file download and asset retrieval functions with clearer parameter descriptions
src/lightning_utilities/docs/formatting.py	Enhanced documentation for changelog transformation and link resolution utilities
src/lightning_utilities/core/rank_zero.py	Added detailed descriptions for rank-based execution decorators and warning cache functionality
src/lightning_utilities/core/overrides.py	Comprehensive docstring for method override detection with support details
src/lightning_utilities/core/inheritance.py	Improved clarity of subclass iteration utility descriptions
src/lightning_utilities/core/imports.py	Enhanced documentation for lazy import mechanisms and dependency checking decorators
src/lightning_utilities/core/enums.py	Clarified enum creation behavior for failed string matches
src/lightning_utilities/core/apply_func.py	Added detailed documentation for collection processing utilities with type checking details
src/lightning_utilities/cli/dependencies.py	Comprehensive documentation for requirement file manipulation functions

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}