Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add formatter to line-length documentation #8150

Merged
merged 1 commit into from
Oct 24, 2023

Conversation

MichaReiser
Copy link
Member

Summary

This PR updates the line-length option documentation to mention its usage in the formatter.

I used this as an opportunity to clarify how the line-length is measured (using unicode width rather than characters) and removed the (characters) unit from the line-too-long and doc-line-too-long lints.

Closes #7574
Closes #7573

Note: I decided not to rename the options to -width, at least for now. Mainly because performing the renaming causes other inconsistencies:

  • The rule line-too-long would need to be renamed to line-too-wide. Same for doc-line-too-long
  • The ignore-overlong-task-comments option would need to be renamed to ignore-overwide-task-comments.

While I like width more, it seemed out of scope to rush these changes before the formatter release (and change it as part of a patch release).

Test Plan

I generated and reviewed the build documentation.

@MichaReiser
Copy link
Member Author

MichaReiser commented Oct 24, 2023

Current dependencies on/for this PR:

This comment was auto-generated by Graphite.

@MichaReiser MichaReiser force-pushed the add-formatter-to-line-length-doc branch from 29142df to 1c1aed4 Compare October 24, 2023 02:27
@MichaReiser MichaReiser added documentation Improvements or additions to documentation formatter Related to the formatter labels Oct 24, 2023
@@ -107,7 +107,7 @@ To configure Ruff, let's create a `pyproject.toml` file in our project's root di

```toml
[tool.ruff]
# Set the maximum line length to 79 characters.
# Set the maximum line length to 79.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm undecided if we should remove characters from here. I don't think mentioning it is necessary, most will assume characters anyway.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm in favor of removing it

@github-actions
Copy link
Contributor

github-actions bot commented Oct 24, 2023

PR Check Results

Ecosystem

ℹ️ ecosystem check detected changes. (+1683, -1683, 0 error(s))

rasa (+9, -9)

- data/test_classes/custom_graph_components/nlu_dense.py:115:89: E501 Line too long (95 > 88 characters)
+ data/test_classes/custom_graph_components/nlu_dense.py:115:89: E501 Line too long (95 > 88)
- data/test_classes/custom_graph_components/nlu_sparse.py:156:89: E501 Line too long (90 > 88 characters)
+ data/test_classes/custom_graph_components/nlu_sparse.py:156:89: E501 Line too long (90 > 88)
- data/test_classes/custom_slots.py:11:89: E501 Line too long (93 > 88 characters)
+ data/test_classes/custom_slots.py:11:89: E501 Line too long (93 > 88)
- scripts/evaluate_release_tag.py:14:89: E501 Line too long (106 > 88 characters)
+ scripts/evaluate_release_tag.py:14:89: E501 Line too long (106 > 88)
- scripts/evaluate_release_tag.py:43:89: E501 Line too long (120 > 88 characters)
+ scripts/evaluate_release_tag.py:43:89: E501 Line too long (120 > 88)
- scripts/evaluate_release_tag.py:57:89: E501 Line too long (94 > 88 characters)
+ scripts/evaluate_release_tag.py:57:89: E501 Line too long (94 > 88)
- scripts/prepare_nightly_release.py:81:89: E501 Line too long (95 > 88 characters)
+ scripts/prepare_nightly_release.py:81:89: E501 Line too long (95 > 88)
- scripts/prepare_nightly_release.py:89:89: E501 Line too long (103 > 88 characters)
+ scripts/prepare_nightly_release.py:89:89: E501 Line too long (103 > 88)
- scripts/release.py:315:89: E501 Line too long (99 > 88 characters)
+ scripts/release.py:315:89: E501 Line too long (99 > 88)

aws-sam-cli (+186, -186)

- tests/end_to_end/test_runtimes_e2e.py:23:121: E501 Line too long (121 > 120 characters)
+ tests/end_to_end/test_runtimes_e2e.py:23:121: E501 Line too long (121 > 120)
- tests/integration/buildcmd/build_integ_base.py:1051:121: E501 Line too long (128 > 120 characters)
+ tests/integration/buildcmd/build_integ_base.py:1051:121: E501 Line too long (128 > 120)
- tests/integration/buildcmd/build_integ_base.py:196:121: E501 Line too long (154 > 120 characters)
+ tests/integration/buildcmd/build_integ_base.py:196:121: E501 Line too long (154 > 120)
- tests/integration/buildcmd/build_integ_base.py:636:121: E501 Line too long (126 > 120 characters)
+ tests/integration/buildcmd/build_integ_base.py:636:121: E501 Line too long (126 > 120)
- tests/integration/buildcmd/test_build_cmd.py:2339:121: E501 Line too long (125 > 120 characters)
+ tests/integration/buildcmd/test_build_cmd.py:2339:121: E501 Line too long (125 > 120)
- tests/integration/buildcmd/test_build_cmd.py:2554:121: E501 Line too long (125 > 120 characters)
+ tests/integration/buildcmd/test_build_cmd.py:2554:121: E501 Line too long (125 > 120)
- tests/integration/buildcmd/test_build_terraform_applications_other_cases.py:422:121: E501 Line too long (136 > 120 characters)
+ tests/integration/buildcmd/test_build_terraform_applications_other_cases.py:422:121: E501 Line too long (136 > 120)
- tests/integration/delete/test_delete_command.py:21:121: E501 Line too long (121 > 120 characters)
+ tests/integration/delete/test_delete_command.py:21:121: E501 Line too long (121 > 120)
- tests/integration/deploy/test_deploy_command.py:18:121: E501 Line too long (121 > 120 characters)
+ tests/integration/deploy/test_deploy_command.py:18:121: E501 Line too long (121 > 120)
- tests/integration/deploy/test_deploy_command.py:753:121: E501 Line too long (125 > 120 characters)
+ tests/integration/deploy/test_deploy_command.py:753:121: E501 Line too long (125 > 120)
- tests/integration/deploy/test_managed_stack_deploy.py:16:121: E501 Line too long (121 > 120 characters)
+ tests/integration/deploy/test_managed_stack_deploy.py:16:121: E501 Line too long (121 > 120)
- tests/integration/deploy/test_managed_stack_deploy.py:17:121: E501 Line too long (121 > 120 characters)
+ tests/integration/deploy/test_managed_stack_deploy.py:17:121: E501 Line too long (121 > 120)
- tests/integration/init/schemas/schemas_test_data_setup.py:174:121: E501 Line too long (159 > 120 characters)
+ tests/integration/init/schemas/schemas_test_data_setup.py:174:121: E501 Line too long (159 > 120)
- tests/integration/init/schemas/schemas_test_data_setup.py:181:121: E501 Line too long (142 > 120 characters)
+ tests/integration/init/schemas/schemas_test_data_setup.py:181:121: E501 Line too long (142 > 120)
- tests/integration/init/schemas/schemas_test_data_setup.py:190:121: E501 Line too long (159 > 120 characters)
+ tests/integration/init/schemas/schemas_test_data_setup.py:190:121: E501 Line too long (159 > 120)
- tests/integration/init/schemas/schemas_test_data_setup.py:191:121: E501 Line too long (132 > 120 characters)
+ tests/integration/init/schemas/schemas_test_data_setup.py:191:121: E501 Line too long (132 > 120)
- tests/integration/init/test_init_command.py:499:121: E501 Line too long (155 > 120 characters)
+ tests/integration/init/test_init_command.py:499:121: E501 Line too long (155 > 120)
- tests/integration/local/invoke/test_integrations_cli.py:1095:121: E501 Line too long (143 > 120 characters)
+ tests/integration/local/invoke/test_integrations_cli.py:1095:121: E501 Line too long (143 > 120)
- tests/integration/local/invoke/test_integrations_cli.py:19:121: E501 Line too long (125 > 120 characters)
+ tests/integration/local/invoke/test_integrations_cli.py:19:121: E501 Line too long (125 > 120)
- tests/integration/local/start_api/lambda_authorizers/test_cfn_authorizer_definitions.py:213:121: E501 Line too long (160 > 120 characters)
+ tests/integration/local/start_api/lambda_authorizers/test_cfn_authorizer_definitions.py:213:121: E501 Line too long (160 > 120)
- tests/integration/local/start_api/lambda_authorizers/test_cfn_authorizer_definitions.py:248:121: E501 Line too long (160 > 120 characters)
+ tests/integration/local/start_api/lambda_authorizers/test_cfn_authorizer_definitions.py:248:121: E501 Line too long (160 > 120)
- tests/integration/local/start_api/lambda_authorizers/test_cfn_authorizer_definitions.py:283:121: E501 Line too long (160 > 120 characters)
+ tests/integration/local/start_api/lambda_authorizers/test_cfn_authorizer_definitions.py:283:121: E501 Line too long (160 > 120)
- tests/integration/local/start_api/lambda_authorizers/test_cfn_authorizer_definitions.py:318:121: E501 Line too long (160 > 120 characters)
+ tests/integration/local/start_api/lambda_authorizers/test_cfn_authorizer_definitions.py:318:121: E501 Line too long (160 > 120)
- tests/integration/local/start_api/lambda_authorizers/test_swagger_authorizer_definitions.py:181:121: E501 Line too long (170 > 120 characters)
+ tests/integration/local/start_api/lambda_authorizers/test_swagger_authorizer_definitions.py:181:121: E501 Line too long (170 > 120)
- tests/integration/local/start_api/lambda_authorizers/test_swagger_authorizer_definitions.py:222:121: E501 Line too long (170 > 120 characters)
+ tests/integration/local/start_api/lambda_authorizers/test_swagger_authorizer_definitions.py:222:121: E501 Line too long (170 > 120)
- tests/integration/local/start_api/lambda_authorizers/test_swagger_authorizer_definitions.py:263:121: E501 Line too long (170 > 120 characters)
+ tests/integration/local/start_api/lambda_authorizers/test_swagger_authorizer_definitions.py:263:121: E501 Line too long (170 > 120)
- tests/integration/local/start_api/lambda_authorizers/test_swagger_authorizer_definitions.py:303:121: E501 Line too long (170 > 120 characters)
+ tests/integration/local/start_api/lambda_authorizers/test_swagger_authorizer_definitions.py:303:121: E501 Line too long (170 > 120)
- tests/integration/local/start_api/lambda_authorizers/test_swagger_authorizer_definitions.py:344:121: E501 Line too long (170 > 120 characters)
+ tests/integration/local/start_api/lambda_authorizers/test_swagger_authorizer_definitions.py:344:121: E501 Line too long (170 > 120)
- tests/integration/local/start_lambda/test_start_lambda.py:268:121: E501 Line too long (134 > 120 characters)
+ tests/integration/local/start_lambda/test_start_lambda.py:268:121: E501 Line too long (134 > 120)
- tests/integration/package/test_package_command_image.py:18:121: E501 Line too long (123 > 120 characters)
+ tests/integration/package/test_package_command_image.py:18:121: E501 Line too long (123 > 120)
- tests/integration/package/test_package_command_zip.py:15:121: E501 Line too long (123 > 120 characters)
+ tests/integration/package/test_package_command_zip.py:15:121: E501 Line too long (123 > 120)
- tests/integration/package/test_package_command_zip.py:326:121: E501 Line too long (122 > 120 characters)
+ tests/integration/package/test_package_command_zip.py:326:121: E501 Line too long (122 > 120)
- tests/integration/publish/test_command_integ.py:17:121: E501 Line too long (123 > 120 characters)
+ tests/integration/publish/test_command_integ.py:17:121: E501 Line too long (123 > 120)
- tests/integration/sync/test_sync_code.py:29:121: E501 Line too long (121 > 120 characters)
+ tests/integration/sync/test_sync_code.py:29:121: E501 Line too long (121 > 120)
- tests/integration/sync/test_sync_infra.py:25:121: E501 Line too long (121 > 120 characters)
+ tests/integration/sync/test_sync_infra.py:25:121: E501 Line too long (121 > 120)
- tests/integration/sync/test_sync_watch.py:38:121: E501 Line too long (121 > 120 characters)
+ tests/integration/sync/test_sync_watch.py:38:121: E501 Line too long (121 > 120)
- tests/integration/testdata/sync/code/before/makefile_function_create_new_file/main.py:12:121: E501 Line too long (128 > 120 characters)
+ tests/integration/testdata/sync/code/before/makefile_function_create_new_file/main.py:12:121: E501 Line too long (128 > 120)
- tests/integration/validate/test_validate_command.py:24:121: E501 Line too long (121 > 120 characters)
+ tests/integration/validate/test_validate_command.py:24:121: E501 Line too long (121 > 120)
- tests/regression/deploy/test_deploy_regression.py:15:121: E501 Line too long (126 > 120 characters)
+ tests/regression/deploy/test_deploy_regression.py:15:121: E501 Line too long (126 > 120)
- tests/regression/deploy/test_deploy_regression.py:16:121: E501 Line too long (123 > 120 characters)
+ tests/regression/deploy/test_deploy_regression.py:16:121: E501 Line too long (123 > 120)
- tests/regression/package/test_package_regression.py:7:121: E501 Line too long (126 > 120 characters)
+ tests/regression/package/test_package_regression.py:7:121: E501 Line too long (126 > 120)
- tests/regression/package/test_package_regression.py:8:121: E501 Line too long (123 > 120 characters)
+ tests/regression/package/test_package_regression.py:8:121: E501 Line too long (123 > 120)
- tests/smoke/download_sar_templates.py:26:121: E501 Line too long (139 > 120 characters)
+ tests/smoke/download_sar_templates.py:26:121: E501 Line too long (139 > 120)
- tests/smoke/test_all_commands.py:59:121: E501 Line too long (121 > 120 characters)
+ tests/smoke/test_all_commands.py:59:121: E501 Line too long (121 > 120)
- tests/unit/cli/test_import_module_proxy.py:37:121: E501 Line too long (178 > 120 characters)
+ tests/unit/cli/test_import_module_proxy.py:37:121: E501 Line too long (178 > 120)
- tests/unit/commands/_utils/test_template.py:125:121: E501 Line too long (124 > 120 characters)
+ tests/unit/commands/_utils/test_template.py:125:121: E501 Line too long (124 > 120)
- tests/unit/commands/deploy/core/test_command.py:54:121: E501 Line too long (123 > 120 characters)
+ tests/unit/commands/deploy/core/test_command.py:54:121: E501 Line too long (123 > 120)
- tests/unit/commands/deploy/test_guided_context.py:144:121: E501 Line too long (126 > 120 characters)
+ tests/unit/commands/deploy/test_guided_context.py:144:121: E501 Line too long (126 > 120)
- tests/unit/commands/deploy/test_guided_context.py:215:121: E501 Line too long (126 > 120 characters)
+ tests/unit/commands/deploy/test_guided_context.py:215:121: E501 Line too long (126 > 120)
- tests/unit/commands/deploy/test_guided_context.py:294:121: E501 Line too long (126 > 120 characters)
+ tests/unit/commands/deploy/test_guided_context.py:294:121: E501 Line too long (126 > 120)
- tests/unit/commands/deploy/test_guided_context.py:414:121: E501 Line too long (121 > 120 characters)
+ tests/unit/commands/deploy/test_guided_context.py:414:121: E501 Line too long (121 > 120)
- tests/unit/commands/deploy/test_guided_context.py:418:121: E501 Line too long (126 > 120 characters)
+ tests/unit/commands/deploy/test_guided_context.py:418:121: E501 Line too long (126 > 120)
- tests/unit/commands/deploy/test_guided_context.py:497:121: E501 Line too long (126 > 120 characters)
+ tests/unit/commands/deploy/test_guided_context.py:497:121: E501 Line too long (126 > 120)
- tests/unit/commands/deploy/test_guided_context.py:656:121: E501 Line too long (126 > 120 characters)
+ tests/unit/commands/deploy/test_guided_context.py:656:121: E501 Line too long (126 > 120)
- tests/unit/commands/deploy/test_guided_context.py:710:121: E501 Line too long (126 > 120 characters)
+ tests/unit/commands/deploy/test_guided_context.py:710:121: E501 Line too long (126 > 120)
- tests/unit/commands/deploy/test_guided_context.py:774:121: E501 Line too long (126 > 120 characters)
+ tests/unit/commands/deploy/test_guided_context.py:774:121: E501 Line too long (126 > 120)
- tests/unit/commands/deploy/test_guided_context.py:833:121: E501 Line too long (126 > 120 characters)
+ tests/unit/commands/deploy/test_guided_context.py:833:121: E501 Line too long (126 > 120)
- tests/unit/commands/deploy/test_guided_context.py:89:121: E501 Line too long (126 > 120 characters)
+ tests/unit/commands/deploy/test_guided_context.py:89:121: E501 Line too long (126 > 120)
- tests/unit/commands/deploy/test_guided_context.py:903:121: E501 Line too long (126 > 120 characters)
+ tests/unit/commands/deploy/test_guided_context.py:903:121: E501 Line too long (126 > 120)
- tests/unit/commands/deploy/test_guided_context.py:978:121: E501 Line too long (126 > 120 characters)
+ tests/unit/commands/deploy/test_guided_context.py:978:121: E501 Line too long (126 > 120)
- tests/unit/commands/init/test_cli.py:1681:121: E501 Line too long (143 > 120 characters)
+ tests/unit/commands/init/test_cli.py:1681:121: E501 Line too long (143 > 120)
- tests/unit/commands/init/test_cli.py:1827:121: E501 Line too long (134 > 120 characters)
+ tests/unit/commands/init/test_cli.py:1827:121: E501 Line too long (134 > 120)
- tests/unit/commands/init/test_cli.py:1875:121: E501 Line too long (138 > 120 characters)
+ tests/unit/commands/init/test_cli.py:1875:121: E501 Line too long (138 > 120)
- tests/unit/commands/init/test_cli.py:2412:121: E501 Line too long (150 > 120 characters)
+ tests/unit/commands/init/test_cli.py:2412:121: E501 Line too long (150 > 120)
- tests/unit/commands/init/test_cli.py:570:121: E501 Line too long (125 > 120 characters)
+ tests/unit/commands/init/test_cli.py:570:121: E501 Line too long (125 > 120)
- tests/unit/commands/init/test_cli.py:614:121: E501 Line too long (129 > 120 characters)
+ tests/unit/commands/init/test_cli.py:614:121: E501 Line too long (129 > 120)
- tests/unit/commands/list/endpoints/test_endpoints_context.py:180:121: E501 Line too long (121 > 120 characters)
+ tests/unit/commands/list/endpoints/test_endpoints_context.py:180:121: E501 Line too long (121 > 120)
- tests/unit/commands/list/endpoints/test_endpoints_context.py:267:121: E501 Line too long (157 > 120 characters)
+ tests/unit/commands/list/endpoints/test_endpoints_context.py:267:121: E501 Line too long (157 > 120)
- tests/unit/commands/list/endpoints/test_endpoints_context.py:279:121: E501 Line too long (157 > 120 characters)
+ tests/unit/commands/list/endpoints/test_endpoints_context.py:279:121: E501 Line too long (157 > 120)
- tests/unit/commands/list/endpoints/test_endpoints_context.py:79:121: E501 Line too long (157 > 120 characters)
+ tests/unit/commands/list/endpoints/test_endpoints_context.py:79:121: E501 Line too long (157 > 120)
- tests/unit/commands/list/endpoints/test_endpoints_context.py:937:121: E501 Line too long (754 > 120 characters)
+ tests/unit/commands/list/endpoints/test_endpoints_context.py:937:121: E501 Line too long (754 > 120)
- tests/unit/commands/list/endpoints/test_endpoints_context.py:984:121: E501 Line too long (1267 > 120 characters)
+ tests/unit/commands/list/endpoints/test_endpoints_context.py:984:121: E501 Line too long (1267 > 120)
- tests/unit/commands/list/resources/test_resources_context.py:155:121: E501 Line too long (619 > 120 characters)
+ tests/unit/commands/list/resources/test_resources_context.py:155:121: E501 Line too long (619 > 120)
- tests/unit/commands/list/resources/test_resources_context.py:186:121: E501 Line too long (615 > 120 characters)
+ tests/unit/commands/list/resources/test_resources_context.py:186:121: E501 Line too long (615 > 120)
- tests/unit/commands/list/resources/test_resources_context.py:292:121: E501 Line too long (669 > 120 characters)
+ tests/unit/commands/list/resources/test_resources_context.py:292:121: E501 Line too long (669 > 120)
- tests/unit/commands/list/resources/test_resources_context.py:87:121: E501 Line too long (157 > 120 characters)
+ tests/unit/commands/list/resources/test_resources_context.py:87:121: E501 Line too long (157 > 120)
- tests/unit/commands/list/stack_outputs/test_stack_outputs_context.py:26:121: E501 Line too long (130 > 120 characters)
+ tests/unit/commands/list/stack_outputs/test_stack_outputs_context.py:26:121: E501 Line too long (130 > 120)
- tests/unit/commands/local/cli_common/test_invoke_context.py:207:121: E501 Line too long (126 > 120 characters)
+ tests/unit/commands/local/cli_common/test_invoke_context.py:207:121: E501 Line too long (126 > 120)
- tests/unit/commands/local/lib/test_cfn_api_provider.py:1135:121: E501 Line too long (185 > 120 characters)
+ tests/unit/commands/local/lib/test_cfn_api_provider.py:1135:121: E501 Line too long (185 > 120)
- tests/unit/commands/local/lib/test_cfn_api_provider.py:1137:121: E501 Line too long (138 > 120 characters)
+ tests/unit/commands/local/lib/test_cfn_api_provider.py:1137:121: E501 Line too long (138 > 120)
- tests/unit/commands/local/lib/test_cfn_api_provider.py:784:121: E501 Line too long (122 > 120 characters)
+ tests/unit/commands/local/lib/test_cfn_api_provider.py:784:121: E501 Line too long (122 > 120)
- tests/unit/commands/local/lib/test_cfn_api_provider.py:809:121: E501 Line too long (122 > 120 characters)
+ tests/unit/commands/local/lib/test_cfn_api_provider.py:809:121: E501 Line too long (122 > 120)
- tests/unit/commands/local/lib/test_sam_function_provider.py:117:121: E501 Line too long (157 > 120 characters)
+ tests/unit/commands/local/lib/test_sam_function_provider.py:117:121: E501 Line too long (157 > 120)
- tests/unit/commands/local/lib/test_sam_function_provider.py:430:121: E501 Line too long (121 > 120 characters)
+ tests/unit/commands/local/lib/test_sam_function_provider.py:430:121: E501 Line too long (121 > 120)
- tests/unit/commands/local/lib/test_sam_function_provider.py:514:121: E501 Line too long (157 > 120 characters)
+ tests/unit/commands/local/lib/test_sam_function_provider.py:514:121: E501 Line too long (157 > 120)
- tests/unit/commands/local/lib/test_sam_function_provider.py:586:121: E501 Line too long (124 > 120 characters)
+ tests/unit/commands/local/lib/test_sam_function_provider.py:586:121: E501 Line too long (124 > 120)
- tests/unit/commands/local/lib/validators/test_lambda_auth_props.py:231:121: E501 Line too long (136 > 120 characters)
+ tests/unit/commands/local/lib/validators/test_lambda_auth_props.py:231:121: E501 Line too long (136 > 120)
- tests/unit/commands/local/lib/validators/test_lambda_auth_props.py:245:121: E501 Line too long (130 > 120 characters)
+ tests/unit/commands/local/lib/validators/test_lambda_auth_props.py:245:121: E501 Line too long (130 > 120)
- tests/unit/commands/local/lib/validators/test_lambda_auth_props.py:64:121: E501 Line too long (124 > 120 characters)
+ tests/unit/commands/local/lib/validators/test_lambda_auth_props.py:64:121: E501 Line too long (124 > 120)
- tests/unit/commands/local/lib/validators/test_lambda_auth_props.py:76:121: E501 Line too long (162 > 120 characters)
+ tests/unit/commands/local/lib/validators/test_lambda_auth_props.py:76:121: E501 Line too long (162 > 120)
- tests/unit/commands/pipeline/init/test_initeractive_init_flow.py:168:121: E501 Line too long (134 > 120 characters)
+ tests/unit/commands/pipeline/init/test_initeractive_init_flow.py:168:121: E501 Line too long (134 > 120)
- tests/unit/commands/pipeline/init/test_initeractive_init_flow.py:228:121: E501 Line too long (134 > 120 characters)
+ tests/unit/commands/pipeline/init/test_initeractive_init_flow.py:228:121: E501 Line too long (134 > 120)
- tests/unit/commands/pipeline/init/test_initeractive_init_flow.py:504:121: E501 Line too long (128 > 120 characters)
+ tests/unit/commands/pipeline/init/test_initeractive_init_flow.py:504:121: E501 Line too long (128 > 120)
- tests/unit/commands/pipeline/init/test_initeractive_init_flow.py:582:121: E501 Line too long (128 > 120 characters)
+ tests/unit/commands/pipeline/init/test_initeractive_init_flow.py:582:121: E501 Line too long (128 > 120)
- tests/unit/commands/remote/invoke/core/test_command.py:58:121: E501 Line too long (127 > 120 characters)
+ tests/unit/commands/remote/invoke/core/test_command.py:58:121: E501 Line too long (127 > 120)
- tests/unit/commands/remote/invoke/core/test_command.py:65:121: E501 Line too long (140 > 120 characters)
+ tests/unit/commands/remote/invoke/core/test_command.py:65:121: E501 Line too long (140 > 120)
- tests/unit/commands/remote/invoke/core/test_command.py:72:121: E501 Line too long (121 > 120 characters)
+ tests/unit/commands/remote/invoke/core/test_command.py:72:121: E501 Line too long (121 > 120)
- tests/unit/commands/remote/test_event/core/test_command.py:106:121: E501 Line too long (124 > 120 characters)
+ tests/unit/commands/remote/test_event/core/test_command.py:106:121: E501 Line too long (124 > 120)
- tests/unit/commands/remote/test_event/core/test_command.py:113:121: E501 Line too long (143 > 120 characters)
+ tests/unit/commands/remote/test_event/core/test_command.py:113:121: E501 Line too long (143 > 120)
- tests/unit/commands/remote/test_event/core/test_command.py:120:121: E501 Line too long (158 > 120 characters)
+ tests/unit/commands/remote/test_event/core/test_command.py:120:121: E501 Line too long (158 > 120)
- tests/unit/commands/remote/test_event/core/test_command.py:127:121: E501 Line too long (158 > 120 characters)
+ tests/unit/commands/remote/test_event/core/test_command.py:127:121: E501 Line too long (158 > 120)
- tests/unit/commands/remote/test_event/core/test_command.py:232:121: E501 Line too long (134 > 120 characters)
+ tests/unit/commands/remote/test_event/core/test_command.py:232:121: E501 Line too long (134 > 120)
- tests/unit/commands/remote/test_event/core/test_command.py:55:121: E501 Line too long (144 > 120 characters)
+ tests/unit/commands/remote/test_event/core/test_command.py:55:121: E501 Line too long (144 > 120)
- tests/unit/commands/remote/test_event/core/test_command.py:62:121: E501 Line too long (131 > 120 characters)
+ tests/unit/commands/remote/test_event/core/test_command.py:62:121: E501 Line too long (131 > 120)
- tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1014:121: E501 Line too long (121 > 120 characters)
+ tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1014:121: E501 Line too long (121 > 120)
- tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1015:121: E501 Line too long (136 > 120 characters)
+ tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1015:121: E501 Line too long (136 > 120)
- tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1023:121: E501 Line too long (132 > 120 characters)
+ tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1023:121: E501 Line too long (132 > 120)
- tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1026:121: E501 Line too long (132 > 120 characters)
+ tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1026:121: E501 Line too long (132 > 120)
- tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1027:121: E501 Line too long (124 > 120 characters)
+ tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1027:121: E501 Line too long (124 > 120)
- tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1063:121: E501 Line too long (139 > 120 characters)
+ tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1063:121: E501 Line too long (139 > 120)
- tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1072:121: E501 Line too long (139 > 120 characters)
+ tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1072:121: E501 Line too long (139 > 120)
- tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1100:121: E501 Line too long (121 > 120 characters)
+ tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1100:121: E501 Line too long (121 > 120)
- tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1109:121: E501 Line too long (139 > 120 characters)
+ tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1109:121: E501 Line too long (139 > 120)
- tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1113:121: E501 Line too long (146 > 120 characters)
+ tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1113:121: E501 Line too long (146 > 120)
- tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1122:121: E501 Line too long (139 > 120 characters)
+ tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1122:121: E501 Line too long (139 > 120)
- tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1126:121: E501 Line too long (146 > 120 characters)
+ tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1126:121: E501 Line too long (146 > 120)
- tests/unit/hook_packages/terraform/hooks/prepare/prepare_base.py:1151:121: E501 Line too long (125 > 120 characters)
+ tests/unit/hook_packages/...*[Comment body truncated]*

@MichaReiser MichaReiser force-pushed the add-formatter-to-line-length-doc branch from 1c1aed4 to de85ade Compare October 24, 2023 07:45
@MichaReiser MichaReiser enabled auto-merge (squash) October 24, 2023 07:45
Comment on lines +357 to +358
/// The length is determined by the number of characters per line, except for lines containing East Asian characters or emojis.
/// For these lines, the [unicode width](https://unicode.org/reports/tr11/) of each character is added up to determine the length.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// The length is determined by the number of characters per line, except for lines containing East Asian characters or emojis.
/// For these lines, the [unicode width](https://unicode.org/reports/tr11/) of each character is added up to determine the length.
/// The length is determined by the [unicode width](https://unicode.org/reports/tr11/). For ASCII text,
/// this is number of characters, but for others such as East Asian characters or emoji, the width varies.
/// Note that the unicode width does not necessarily line up with columns in your editor.

@@ -107,7 +107,7 @@ To configure Ruff, let's create a `pyproject.toml` file in our project's root di

```toml
[tool.ruff]
# Set the maximum line length to 79 characters.
# Set the maximum line length to 79.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm in favor of removing it

@MichaReiser MichaReiser merged commit 2587aef into main Oct 24, 2023
15 of 31 checks passed
@MichaReiser MichaReiser deleted the add-formatter-to-line-length-doc branch October 24, 2023 07:55
/// documentation (`W505`), including standalone comments. By default,
/// this is set to null which disables reporting violations.
///
/// The length is determined by the number of characters per line, except for lines containinAsian characters or emojis.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

containinAsian

typo?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most certainly

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation formatter Related to the formatter
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename pydocstyle.max-doc-length to max-doc-width Rename line-length to line-width
4 participants