Skip to content

Commit

Permalink
docs: modified links in basic_usage.md and modified glossary definiti…
Browse files Browse the repository at this point in the history
…on as some of afg's wfm format si not supported.
  • Loading branch information
u625355 committed Aug 30, 2024
1 parent 0150074 commit 3d66504
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@

# tm_data_types: Test & Measurement Data Types

`tm_data_types` provides tools to convert, edit, and write waveform data from Tektronix instruments.
`tm_data_types` provides tools to convert, edit, and write waveform data from Test & Measurement devices.
It simplifies handling waveform formats like CSV, WFM, and BIN in Python.

`tm_data_types` can be used to:

- **Convert** CSV, WFM, and BIN format into the waveform object format,
- **Convert** CSV, WFM, and BIN format into a waveform object,
- **Add or edit** waveform metadata,
- **Write** a valid waveform object to a file.

Expand Down
4 changes: 2 additions & 2 deletions docs/basic_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ project.

## Write Data

`tm_data_types` can be used for writing data to a file using [`write_file()`][tm_data_types.io_factory_methods.write_file].
`tm_data_types` can be used for writing data to a file using [`write_file()`][tm_data_types.write_file].

```python
# fmt: off
Expand All @@ -23,7 +23,7 @@ project.

## Write Analog Waveform to CSV file

`tm_data_types` can be used to write an analog waveform to a CSV file using the [`WaveformFileCSVAnalog`][tm_data_types.files_and_formats.csv.data_formats.analog.WaveformFileCSVAnalog] class.
`tm_data_types` can be used to write an analog waveform to a CSV file using the [`WaveformFileCSVAnalog`][tm_data_types.WaveformFileCSVAnalog] class.

```python
# fmt: off
Expand Down
2 changes: 1 addition & 1 deletion docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ Scope
: Oscilloscope

WFM
: Waveform format used by test and measurement devices.
: Waveform format used by test & measurement scopes and arbitrary waveform generators.

0 comments on commit 3d66504

Please sign in to comment.