InSync 7173e6a20b Use stripping block (|-) for page descriptions (#14980) ...

## Summary

Resolves #14976.

Currently, we uses this "[plain
scalar](https://yaml.org/spec/1.2.2/#733-plain-style)" format:

```yaml
description: Checks for `if key in dictionary: del dictionary[key]`.
```

Plain scalar must not contain the sequence `: `, however, so the above
is invalid.

This PR changes that to:

```yaml
description: |-
  Checks for `if key in dictionary: del dictionary[key]`.
```

`|` denotes a "[block
scalar](https://yaml.org/spec/1.2.2/#81-block-scalar-styles)", whereas
[the `-` chomping
indicator](https://yaml.org/spec/1.2.2/#8112-block-chomping-indicator)
requires that a trailing newline, if any, must be stripped.

## Test Plan


![](https://github.com/user-attachments/assets/f00b606a-d6fe-46ac-a1c5-6a8665204ea3)

2024-12-15 17:07:29 +01:00

..

benchmarks

Bump version to 0.8.3 (#14937)

2024-12-12 14:13:06 +00:00

knot_benchmark

[red-knot] knot benchmark: fix --knot-path arg (#13923)

2024-10-25 11:43:39 +02:00

release

Update release script to match uv (#11496)

2024-07-03 07:35:28 -05:00

_mdformat_utils.py

Add a formatting step using mdformat as part of generate_mkdocs.py (#10484)

2024-03-21 00:37:40 +00:00

_utils.py

Use __future__ imports in scripts (#5301)

2023-06-22 11:40:16 -04:00

add_plugin.py

[pydoclint] Implement docstring-missing-exception and docstring-extraneous-exception (DOC501, DOC502) (#11471)

2024-07-20 19:41:51 +00:00

add_rule.py

Use a derive macro for Violations (#14557)

2024-11-27 09:41:40 +00:00

check_docs_formatted.py

Format PYI examples in docs as .pyi-file snippets (#13116)

2024-08-28 13:20:40 +01:00

check_ecosystem.py

Remove the deprecated E999 rule code (#14428)

2024-11-20 13:11:51 +01:00

Dockerfile.ecosystem

Remove outdated feature flag from Dockerfile.ecosystem (#4620)

2023-05-24 08:19:08 +00:00

ecosystem_all_check_entrypoint.sh

Make ecosystem all check more generic (#4629)

2023-05-24 16:26:23 +02:00

ecosystem_all_check.py

Update pre-commit dependencies (#10698)

2024-04-06 23:00:41 +00:00

ecosystem_all_check.sh

Rename Autofix to Fix (#7657)

2023-09-28 10:53:05 +00:00

formatter_ecosystem_checks.sh

Improve the performance of the formatter instability check job (#14471)

2024-11-20 08:55:10 -06:00

generate_builtin_modules.py

Add a new script to generate builtin module names (#12696)

2024-08-05 21:33:36 +01:00

generate_known_standard_library.py

Add a new script to generate builtin module names (#12696)

2024-08-05 21:33:36 +01:00

generate_mkdocs.py

Use stripping block (|-) for page descriptions (#14980)

2024-12-15 17:07:29 +01:00

pyproject.toml

Update pre-commit dependencies (#13289)

2024-09-09 11:11:01 +00:00

release.sh

Update release script to match uv (#11496)

2024-07-03 07:35:28 -05:00

transform_readme.py

Update pre-commit dependencies (#10698)

2024-04-06 23:00:41 +00:00

update_ambiguous_characters.py

Update pre-commit dependencies (#10698)

2024-04-06 23:00:41 +00:00

update_schemastore.py

Use https by default in schema store update script (#11882)

2024-06-14 17:30:54 -05:00