Python
/
uv
mirror of https://github.com/astral-sh/uv
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Wrap scenario descriptions in docstrings (#787) 

Otherwise, the lines can get kind of long.
This commit is contained in:
Zanie Blue 2024-01-04 13:43:50 -06:00 committed by GitHub
parent f89c6456e3
commit 8ac6f9a198
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
crates/puffin-cli/tests/pip_install_scenarios.rs
View File

@ -110,7 +110,8 @@ fn requires_exact_version_does_not_exist() -> Result<()> {
/// requires-greater-version-does-not-exist /// requires-greater-version-does-not-exist
/// ///
/// The user requires a version of `a` greater than `1.0.0` but only smaller or equal versions exist /// The user requires a version of `a` greater than `1.0.0` but only smaller or
/// equal versions exist
/// ///
/// requires-greater-version-does-not-exist-d34821ba /// requires-greater-version-does-not-exist-d34821ba
/// ├── environment /// ├── environment
@ -161,7 +162,8 @@ fn requires_greater_version_does_not_exist() -> Result<()> {
/// requires-less-version-does-not-exist /// requires-less-version-does-not-exist
/// ///
/// The user requires a version of `a` less than `1.0.0` but only larger versions exist /// The user requires a version of `a` less than `1.0.0` but only larger versions
/// exist
/// ///
/// requires-less-version-does-not-exist-4088ec1b /// requires-less-version-does-not-exist-4088ec1b
/// ├── environment /// ├── environment
@ -318,7 +320,8 @@ fn requires_direct_incompatible_versions() -> Result<()> {
/// requires-transitive-incompatible-with-root-version /// requires-transitive-incompatible-with-root-version
/// ///
/// The user requires packages `a` and `b` but `a` requires a different version of `b` /// The user requires packages `a` and `b` but `a` requires a different version of
/// `b`
/// ///
/// requires-transitive-incompatible-with-root-version-b3c83bbd /// requires-transitive-incompatible-with-root-version-b3c83bbd
/// ├── environment /// ├── environment
@ -381,7 +384,8 @@ fn requires_transitive_incompatible_with_root_version() -> Result<()> {
/// requires-transitive-incompatible-with-transitive /// requires-transitive-incompatible-with-transitive
/// ///
/// The user requires package `a` and `b`; `a` and `b` require different versions of `c` /// The user requires package `a` and `b`; `a` and `b` require different versions of
/// `c`
/// ///
/// requires-transitive-incompatible-with-transitive-a35362d1 /// requires-transitive-incompatible-with-transitive-a35362d1
/// ├── environment /// ├── environment

4
scripts/scenarios/template.mustache
View File

@ -20,7 +20,9 @@ mod common;
/// {{name}} /// {{name}}
/// ///
/// {{description}} {{#description_lines}}
/// {{.}}
{{/description_lines}}
/// ///
/// {{prefix}} /// {{prefix}}
{{#tree}} {{#tree}}

5
scripts/scenarios/update.py
View File

@ -20,6 +20,7 @@ import json
import shutil import shutil
import subprocess import subprocess
import sys import sys
import textwrap
from pathlib import Path from pathlib import Path
@ -132,6 +133,10 @@ for index, scenario in enumerate(data["scenarios"]):
if scenario["name"] == "example": if scenario["name"] == "example":
data["scenarios"].pop(index) data["scenarios"].pop(index)
# Wrap the description onto multiple lines
for scenario in data["scenarios"]:
scenario["description_lines"] = textwrap.wrap(scenario["description"], width=80)
# Render the template # Render the template
print("Rendering template...", file=sys.stderr) print("Rendering template...", file=sys.stderr)
output = chevron_blue.render(template=TEMPLATE.read_text(), data=data, no_escape=True) output = chevron_blue.render(template=TEMPLATE.read_text(), data=data, no_escape=True)