Pylint comments appear in the API documentation (e.g., # pylint: disable=line-too-long)

[andylizf]

In the SkyPilot API documentation where pylint comments, such as # pylint: disable=line-too-long, are included in the generated documentation. For example:

The job recovery strategy to use for the managed job to recover the cluster from preemption. Refer to recovery_strategy module # pylint: disable=line-too-long for more details. When a dict is provided, it can have the following fields:

This inclusion seems unintended and appears out of place in the user-facing documentation.

Suggested Fixes:

1. Reposition the Pylint Comments
   Place # pylint directives outside of docstrings, ideally above the function or module definitions. For instance:

   # pylint: disable=line-too-long
   def some_function():
       """
       The job recovery strategy to use for the managed job to recover the cluster
       from preemption. Refer to the recovery_strategy module for more details.
       """

2. Filter Pylint Comments During Documentation Generation
   Use a Sphinx filter to strip out # pylint: comments during documentation generation. This can be implemented using either:

   • Regex-based filtering to exclude lines containing # pylint.
   • AST-based filtering to clean up docstrings before they are processed by Sphinx.

I think cleaning this up would significantly improve the documentation’s clarity and polish.