Skip to content

Fix paths in files config examples #167

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Feb 12, 2025
Merged

Fix paths in files config examples #167

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/user-guide/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,15 +131,15 @@ The following JSON and TOML are equivalent:
{
"files": {
"https://example.com/data.csv": "./data.csv",
"/code.py": "./subdir/code.py"
"./code.py": "./subdir/code.py"
}
}
```

```toml title="Fetch files onto the filesystem with TOML."
[files]
"https://example.com/data.csv" = "./data.csv"
"/code.py" = "./subdir/code.py"
"./code.py" = "./subdir/code.py"
```

If you make the target an empty string, the final "filename" part of the source
Expand All @@ -151,15 +151,15 @@ examples could be equivalently re-written as:
{
"files": {
"https://example.com/data.csv": "",
... etc ...
"./code.py": ""
}
}
```

```toml title="TOML implied filename in the root directory."
[files]
"https://example.com/data.csv" = ""
... etc ...
"./code.py" = ""
```

If the source part of the configuration is either a `.zip` or `.tar.gz` file
Expand Down