Skip to content
Open
Changes from all commits
Commits
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: 5 additions & 3 deletions docs/command-line/tsci-snapshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ tsci snapshot [options] [path]
### Options
- `-u, --update` – write new snapshots to disk.
- `--force-update` – force writing snapshots even when no visual diff is detected.
- `--3d` – also generate 3D preview snapshots.
- `--3d` – generate schematic, PCB, and 3D preview snapshots.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

??? that's not what --3d does

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

image

@seveibar
i wrote the behaviour,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

that is not what this flag does, this flag adds the 3d preview snapshots

- `--pcb-only` – generate only PCB snapshots.
- `--schematic-only` – generate only schematic snapshots.
- `--disable-parts-engine` – disable the parts engine while rendering snapshots.
Expand Down Expand Up @@ -42,6 +42,8 @@ __snapshots__/test.board-pcb.snap.svg
__snapshots__/test.board-schematic.snap.svg
```

If `--3d` is specified, a `-3d.snap.svg` is also produced.
By default, only the PCB and schematic snapshots are produced.

Running without `--update` verifies that the generated output matches the existing snapshots. Differences cause a non-zero exit code.
If `--3d` is specified, the command produces PCB, schematic, and 3D snapshots
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

wat

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

image

that's how the cli working !

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

that is not what this flag does, the flag adds to the existing outputs


Running without `--update` verifies that the generated output matches the existing snapshots. Differences cause a non-zero exit code.
Loading