Apply same linting and code style used in the package to the code examples in the docs #1606
Labels
component: pysdk-team
Related to SageMaker Python SDK Core Issues
contributions welcome
type: documentation
type: maintenance
What did you find confusing? Please describe.
In the docs, the various code blocks do not have a consistent code style and the code examples do not adhere to a standard Python code style in the same way the code in the package itself does. The documentation code blocks would benefit from the same linting and style standards that the package code adheres to.
Describe how documentation can be improved
Example code block in the documentation before linting and code style:
Code block after linting and code style applied (
pylint
,black
, andflake8
):These changes, applied across the documentation, would lead to a more consistent user experience between documentation and package code. The code blocks would then provide examples that adhere to commonly accepted best practices and coding standards for Python.
Additional context
n/a
The text was updated successfully, but these errors were encountered: